voku /
HtmlMin
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 HtmlMinDomObserverOptimizeAttributes 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 HtmlMinDomObserverOptimizeAttributes, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 12 | final class HtmlMinDomObserverOptimizeAttributes implements HtmlMinDomObserverInterface |
||
| 13 | { |
||
| 14 | /** |
||
| 15 | * // https://mathiasbynens.be/demo/javascript-mime-type |
||
| 16 | * // https://developer.mozilla.org/en/docs/Web/HTML/Element/script#attr-type |
||
| 17 | * |
||
| 18 | * @var string[] |
||
| 19 | * |
||
| 20 | * @psalm-var array<string, string> |
||
| 21 | */ |
||
| 22 | private static $executableScriptsMimeTypes = [ |
||
| 23 | 'text/javascript' => '', |
||
| 24 | 'text/ecmascript' => '', |
||
| 25 | 'text/jscript' => '', |
||
| 26 | 'application/javascript' => '', |
||
| 27 | 'application/x-javascript' => '', |
||
| 28 | 'application/ecmascript' => '', |
||
| 29 | ]; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * Receive dom elements before the minification. |
||
| 33 | * |
||
| 34 | * @param SimpleHtmlDomInterface $element |
||
| 35 | * @param HtmlMinInterface $htmlMin |
||
| 36 | * |
||
| 37 | * @return void |
||
| 38 | */ |
||
| 39 | 51 | public function domElementBeforeMinification(SimpleHtmlDomInterface $element, HtmlMinInterface $htmlMin) |
|
| 42 | |||
| 43 | /** |
||
| 44 | * Receive dom elements after the minification. |
||
| 45 | * |
||
| 46 | * @param SimpleHtmlDomInterface $element |
||
| 47 | * @param HtmlMinInterface $htmlMin |
||
| 48 | * |
||
| 49 | * @return void |
||
| 50 | */ |
||
| 51 | 51 | public function domElementAfterMinification(SimpleHtmlDomInterface $element, HtmlMinInterface $htmlMin) |
|
| 52 | { |
||
| 53 | 51 | $attributes = $element->getAllAttributes(); |
|
| 54 | 51 | if ($attributes === null) { |
|
| 55 | 48 | return; |
|
| 56 | } |
||
| 57 | |||
| 58 | 34 | $attrs = []; |
|
| 59 | 34 | foreach ((array) $attributes as $attrName => $attrValue) { |
|
| 60 | |||
| 61 | // ------------------------------------------------------------------------- |
||
| 62 | // Remove optional "http:"-prefix from attributes. |
||
| 63 | // ------------------------------------------------------------------------- |
||
| 64 | |||
| 65 | 34 | if ($htmlMin->isDoRemoveHttpPrefixFromAttributes()) { |
|
| 66 | 5 | $attrValue = $this->removeHttpPrefixHelper( |
|
| 67 | 5 | $attrValue, |
|
| 68 | $attrName, |
||
| 69 | 5 | 'http', |
|
| 70 | $attributes, |
||
| 71 | $htmlMin |
||
| 72 | ); |
||
| 73 | } |
||
| 74 | |||
| 75 | 34 | if ($htmlMin->isDoRemoveHttpsPrefixFromAttributes()) { |
|
| 76 | 1 | $attrValue = $this->removeHttpPrefixHelper( |
|
| 77 | 1 | $attrValue, |
|
| 78 | $attrName, |
||
| 79 | 1 | 'https', |
|
| 80 | $attributes, |
||
| 81 | $htmlMin |
||
| 82 | ); |
||
| 83 | } |
||
| 84 | |||
| 85 | 34 | if ($htmlMin->isDoMakeSameDomainLinksRelative()) { |
|
| 86 | 2 | if (!$htmlMin->isLocalDomainSet()){ |
|
| 87 | $htmlMin->setLocalDomain(); |
||
| 88 | } |
||
| 89 | 2 | $localDomain = $htmlMin->getLocalDomain(); |
|
| 90 | View Code Duplication | if ( |
|
|
|
|||
| 91 | 2 | (($attrName === 'href') || $attrName === 'src' || $attrName === 'srcset' || $attrName === 'action') |
|
| 92 | && |
||
| 93 | 2 | !(isset($attributes['rel']) && $attributes['rel'] === 'external') |
|
| 94 | && |
||
| 95 | 2 | !(isset($attributes['target']) && $attributes['target'] === '_blank') |
|
| 96 | ) { |
||
| 97 | 2 | $attrValue = \preg_replace("/^((https?:)?\/\/)?{$localDomain}(?!\w)(\/?)/", '/', $attrValue); |
|
| 98 | } |
||
| 99 | } |
||
| 100 | |||
| 101 | 34 | if ($this->removeAttributeHelper($element->tag, $attrName, $attrValue, $attributes, $htmlMin)) { |
|
| 102 | 6 | $element->{$attrName} = null; |
|
| 103 | |||
| 104 | 6 | continue; |
|
| 105 | } |
||
| 106 | |||
| 107 | // ------------------------------------------------------------------------- |
||
| 108 | // Sort css-class-names, for better gzip results. |
||
| 109 | // ------------------------------------------------------------------------- |
||
| 110 | |||
| 111 | 34 | if ($htmlMin->isDoSortCssClassNames()) { |
|
| 112 | 33 | $attrValue = $this->sortCssClassNames($attrName, $attrValue); |
|
| 113 | } |
||
| 114 | |||
| 115 | 34 | if ($htmlMin->isDoSortHtmlAttributes()) { |
|
| 116 | 33 | $attrs[$attrName] = $attrValue; |
|
| 117 | 33 | $element->{$attrName} = null; |
|
| 118 | } |
||
| 119 | } |
||
| 120 | |||
| 121 | // ------------------------------------------------------------------------- |
||
| 122 | // Sort html-attributes, for better gzip results. |
||
| 123 | // ------------------------------------------------------------------------- |
||
| 124 | |||
| 125 | 34 | if ($htmlMin->isDoSortHtmlAttributes()) { |
|
| 126 | 33 | \ksort($attrs); |
|
| 127 | 33 | foreach ($attrs as $attrName => $attrValue) { |
|
| 128 | 33 | $attrValue = HtmlDomParser::replaceToPreserveHtmlEntities($attrValue); |
|
| 129 | 33 | $element->setAttribute((string) $attrName, $attrValue, true); |
|
| 130 | } |
||
| 131 | } |
||
| 132 | 34 | } |
|
| 133 | |||
| 134 | /** |
||
| 135 | * Check if the attribute can be removed. |
||
| 136 | * |
||
| 137 | * @param string $tag |
||
| 138 | * @param string $attrName |
||
| 139 | * @param string $attrValue |
||
| 140 | * @param array $allAttr |
||
| 141 | * @param HtmlMinInterface $htmlMin |
||
| 142 | * |
||
| 143 | * @return bool |
||
| 144 | */ |
||
| 145 | 34 | private function removeAttributeHelper($tag, $attrName, $attrValue, $allAttr, HtmlMinInterface $htmlMin): bool |
|
| 216 | |||
| 217 | /** |
||
| 218 | * @param string $attrValue |
||
| 219 | * @param string $attrName |
||
| 220 | * @param string $scheme |
||
| 221 | * @param array $attributes |
||
| 222 | * |
||
| 223 | * @return string |
||
| 224 | */ |
||
| 225 | 5 | private function removeHttpPrefixHelper( |
|
| 245 | |||
| 246 | /** |
||
| 247 | * @param string $attrName |
||
| 248 | * @param string $attrValue |
||
| 249 | * |
||
| 250 | * @return string |
||
| 251 | */ |
||
| 252 | 33 | private function sortCssClassNames($attrName, $attrValue): string |
|
| 274 | } |
||
| 275 |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.