[CLEANUP] Correct spelling of “(un)inlinable” (#705)

… in method, property and variable names. Research indicates that whilst “inlineable” may be a permitted alternative variant, “inlinable” is more correct and mainstream. Part of #380.
MyIntervals · Sep 12, 2019 · ee831be · ee831be
1 parent c8df4de
commit ee831be
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 36 deletions.
diff --git a/src/Emogrifier.php b/src/Emogrifier.php
@@ -478,7 +478,7 @@ protected function process()
 
         $excludedNodes = $this->getNodesToExclude();
         $cssRules = $this->parseCssRules($allCss);
-        foreach ($cssRules['inlineable'] as $cssRule) {
+        foreach ($cssRules['inlinable'] as $cssRule) {
             // There's no real way to test "PHP Warning" output generated by the following XPath query unless PHPUnit
             // converts it to an exception. Unfortunately, this would only apply to tests and not work for production
             // executions, which can still flood logs/output unnecessarily. Instead, Emogrifier's error handler should
@@ -498,7 +498,7 @@ protected function process()
                 if (\in_array($node, $excludedNodes, true)) {
                     continue;
                 }
-                $this->copyInlineableCssToStyleAttribute($node, $cssRule);
+                $this->copyInlinableCssToStyleAttribute($node, $cssRule);
             }
         }
 
@@ -508,7 +508,7 @@ protected function process()
 
         $this->removeImportantAnnotationFromAllInlineStyles();
 
-        $this->copyUninlineableCssToStyleNode($cssRules['uninlineable']);
+        $this->copyUninlinableCssToStyleNode($cssRules['uninlinable']);
 
         \restore_error_handler();
     }
@@ -575,8 +575,8 @@ private function getAllNodesWithStyleAttribute()
      *
      * @param string $css a string of raw CSS code
      *
-     * @return string[][][] A 2-entry array with the key "inlineable" containing rules which can be inlined as `style`
-     *         attributes and the key "uninlineable" containing rules which cannot.  Each value is an array of string
+     * @return string[][][] A 2-entry array with the key "inlinable" containing rules which can be inlined as `style`
+     *         attributes and the key "uninlinable" containing rules which cannot.  Each value is an array of string
      *         sub-arrays with the keys
      *         "media" (the media query string, e.g. "@media screen and (max-width: 480px)",
      *         or an empty string if not from a `@media` rule),
@@ -594,8 +594,8 @@ private function parseCssRules($css)
             $matches = $this->getCssRuleMatches($css);
 
             $cssRules = [
-                'inlineable' => [],
-                'uninlineable' => [],
+                'inlinable' => [],
+                'uninlinable' => [],
             ];
             /** @var string[][] $matches */
             /** @var string[] $cssRule */
@@ -624,12 +624,12 @@ private function parseCssRules($css)
                         // keep track of where it appears in the file, since order is important
                         'line' => $key,
                     ];
-                    $ruleType = ($cssRule['media'] === '' && !$hasUnmatchablePseudo) ? 'inlineable' : 'uninlineable';
+                    $ruleType = ($cssRule['media'] === '' && !$hasUnmatchablePseudo) ? 'inlinable' : 'uninlinable';
                     $cssRules[$ruleType][] = $parsedCssRule;
                 }
             }
 
-            \usort($cssRules['inlineable'], [$this, 'sortBySelectorPrecedence']);
+            \usort($cssRules['inlinable'], [$this, 'sortBySelectorPrecedence']);
 
             $this->caches[static::CACHE_KEY_CSS][$cssKey] = $cssRules;
         }
@@ -956,7 +956,7 @@ private function attributeValueIsImportant($attributeValue)
      *
      * @return void
      */
-    private function copyInlineableCssToStyleAttribute(\DOMElement $node, array $cssRule)
+    private function copyInlinableCssToStyleAttribute(\DOMElement $node, array $cssRule)
     {
         $newStyleDeclarations = $this->parseCssDeclarationsBlock($cssRule['declarationsBlock']);
         if ($newStyleDeclarations === []) {
@@ -979,11 +979,11 @@ private function copyInlineableCssToStyleAttribute(\DOMElement $node, array $css
     /**
      * Applies $cssRules to $this->domDocument, limited to the rules that actually apply to the document.
      *
-     * @param string[][] $cssRules The "uninlineable" array of CSS rules returned by `parseCssRules`
+     * @param string[][] $cssRules The "uninlinable" array of CSS rules returned by `parseCssRules`
      *
      * @return void
      */
-    private function copyUninlineableCssToStyleNode(array $cssRules)
+    private function copyUninlinableCssToStyleNode(array $cssRules)
     {
         $cssRulesRelevantForDocument = \array_filter(
             $cssRules,

diff --git a/src/Emogrifier/CssInliner.php b/src/Emogrifier/CssInliner.php
@@ -185,7 +185,7 @@ public function inlineCss($css = '')
         $excludedNodes = $this->getNodesToExclude();
         $cssRules = $this->parseCssRules($combinedCss);
         $cssSelectorConverter = $this->getCssSelectorConverter();
-        foreach ($cssRules['inlineable'] as $cssRule) {
+        foreach ($cssRules['inlinable'] as $cssRule) {
             try {
                 $nodesMatchingCssSelectors = $this->xPath->query($cssSelectorConverter->toXPath($cssRule['selector']));
             } catch (SyntaxErrorException $e) {
@@ -200,7 +200,7 @@ public function inlineCss($css = '')
                 if (\in_array($node, $excludedNodes, true)) {
                     continue;
                 }
-                $this->copyInlineableCssToStyleAttribute($node, $cssRule);
+                $this->copyInlinableCssToStyleAttribute($node, $cssRule);
             }
         }
 
@@ -210,7 +210,7 @@ public function inlineCss($css = '')
 
         $this->removeImportantAnnotationFromAllInlineStyles();
 
-        $this->copyUninlineableCssToStyleNode($cssRules['uninlineable']);
+        $this->copyUninlinableCssToStyleNode($cssRules['uninlinable']);
 
         return $this;
     }
@@ -277,8 +277,8 @@ private function getAllNodesWithStyleAttribute()
      *
      * @param string $css a string of raw CSS code
      *
-     * @return string[][][] A 2-entry array with the key "inlineable" containing rules which can be inlined as `style`
-     *         attributes and the key "uninlineable" containing rules which cannot.  Each value is an array of string
+     * @return string[][][] A 2-entry array with the key "inlinable" containing rules which can be inlined as `style`
+     *         attributes and the key "uninlinable" containing rules which cannot.  Each value is an array of string
      *         sub-arrays with the keys
      *         "media" (the media query string, e.g. "@media screen and (max-width: 480px)",
      *         or an empty string if not from a `@media` rule),
@@ -299,8 +299,8 @@ private function parseCssRules($css)
         $matches = $this->getCssRuleMatches($css);
 
         $cssRules = [
-            'inlineable' => [],
-            'uninlineable' => [],
+            'inlinable' => [],
+            'uninlinable' => [],
         ];
         /** @var string[][] $matches */
         /** @var string[] $cssRule */
@@ -329,12 +329,12 @@ private function parseCssRules($css)
                     // keep track of where it appears in the file, since order is important
                     'line' => $key,
                 ];
-                $ruleType = ($cssRule['media'] === '' && !$hasUnmatchablePseudo) ? 'inlineable' : 'uninlineable';
+                $ruleType = ($cssRule['media'] === '' && !$hasUnmatchablePseudo) ? 'inlinable' : 'uninlinable';
                 $cssRules[$ruleType][] = $parsedCssRule;
             }
         }
 
-        \usort($cssRules['inlineable'], [$this, 'sortBySelectorPrecedence']);
+        \usort($cssRules['inlinable'], [$this, 'sortBySelectorPrecedence']);
 
         $this->caches[static::CACHE_KEY_CSS][$cssKey] = $cssRules;
 
@@ -620,11 +620,11 @@ private function attributeValueIsImportant($attributeValue)
     /**
      * Applies $cssRules to $this->domDocument, limited to the rules that actually apply to the document.
      *
-     * @param string[][] $cssRules The "uninlineable" array of CSS rules returned by `parseCssRules`
+     * @param string[][] $cssRules The "uninlinable" array of CSS rules returned by `parseCssRules`
      *
      * @return void
      */
-    private function copyUninlineableCssToStyleNode(array $cssRules)
+    private function copyUninlinableCssToStyleNode(array $cssRules)
     {
         $cssRulesRelevantForDocument = \array_filter(
             $cssRules,
@@ -712,7 +712,7 @@ private function replaceUnmatchableNotComponent(array $matches)
      *
      * @return void
      */
-    private function copyInlineableCssToStyleAttribute(\DOMElement $node, array $cssRule)
+    private function copyInlinableCssToStyleAttribute(\DOMElement $node, array $cssRule)
     {
         $newStyleDeclarations = $this->parseCssDeclarationsBlock($cssRule['declarationsBlock']);
         if ($newStyleDeclarations === []) {

diff --git a/tests/Unit/CssInlinerTest.php b/tests/Unit/CssInlinerTest.php
@@ -2621,11 +2621,11 @@ public function inlineCssNotInDebugModeKeepsInvalidOrUnrecognizedSelectorsInMedi
     /**
      * @test
      */
-    public function copyUninlineableCssToStyleNodeHasNoSideEffects()
+    public function copyUninlinableCssToStyleNodeHasNoSideEffects()
     {
         $subject = $this->buildDebugSubject('<html><a>foo</a><p>bar</p></html>');
         // CSS: `a:hover { color: green; } p:hover { color: blue; }`
-        $uninlineableCssRules = [
+        $uninlinableCssRules = [
             [
                 'media' => '',
                 'selector' => 'a:hover',
@@ -2642,18 +2642,18 @@ public function copyUninlineableCssToStyleNodeHasNoSideEffects()
             ],
         ];
 
-        $copyUninlineableCssToStyleNode = new \ReflectionMethod(CssInliner::class, 'copyUninlineableCssToStyleNode');
-        $copyUninlineableCssToStyleNode->setAccessible(true);
+        $copyUninlinableCssToStyleNode = new \ReflectionMethod(CssInliner::class, 'copyUninlinableCssToStyleNode');
+        $copyUninlinableCssToStyleNode->setAccessible(true);
 
         $domDocument = $subject->getDomDocument();
 
-        $copyUninlineableCssToStyleNode->invoke($subject, $uninlineableCssRules);
+        $copyUninlinableCssToStyleNode->invoke($subject, $uninlinableCssRules);
         $expectedHtml = $subject->render();
 
         $styleElement = $domDocument->getElementsByTagName('style')->item(0);
         $styleElement->parentNode->removeChild($styleElement);
 
-        $copyUninlineableCssToStyleNode->invoke($subject, $uninlineableCssRules);
+        $copyUninlinableCssToStyleNode->invoke($subject, $uninlinableCssRules);
 
         self::assertSame($expectedHtml, $subject->render());
     }

diff --git a/tests/Unit/EmogrifierTest.php b/tests/Unit/EmogrifierTest.php
@@ -3185,11 +3185,11 @@ public function emogrifyNotInDebugModeKeepsInvalidOrUnrecognizedSelectorsInMedia
     /**
      * @test
      */
-    public function copyUninlineableCssToStyleNodeHasNoSideEffects()
+    public function copyUninlinableCssToStyleNodeHasNoSideEffects()
     {
         $this->subject->setHtml('<html><a>foo</a><p>bar</p></html>');
         // CSS: `a:hover { color: green; } p:hover { color: blue; }`
-        $uninlineableCssRules = [
+        $uninlinableCssRules = [
             [
                 'media' => '',
                 'selector' => 'a:hover',
@@ -3206,18 +3206,18 @@ public function copyUninlineableCssToStyleNodeHasNoSideEffects()
             ],
         ];
 
-        $copyUninlineableCssToStyleNode = new \ReflectionMethod(Emogrifier::class, 'copyUninlineableCssToStyleNode');
-        $copyUninlineableCssToStyleNode->setAccessible(true);
+        $copyUninlinableCssToStyleNode = new \ReflectionMethod(Emogrifier::class, 'copyUninlinableCssToStyleNode');
+        $copyUninlinableCssToStyleNode->setAccessible(true);
 
         $domDocument = $this->subject->getDomDocument();
 
-        $copyUninlineableCssToStyleNode->invoke($this->subject, $uninlineableCssRules);
+        $copyUninlinableCssToStyleNode->invoke($this->subject, $uninlinableCssRules);
         $expectedHtml = $domDocument->saveHTML();
 
         $styleElement = $domDocument->getElementsByTagName('style')->item(0);
         $styleElement->parentNode->removeChild($styleElement);
 
-        $copyUninlineableCssToStyleNode->invoke($this->subject, $uninlineableCssRules);
+        $copyUninlinableCssToStyleNode->invoke($this->subject, $uninlinableCssRules);
 
         self::assertSame($expectedHtml, $domDocument->saveHTML());
     }