[CLEANUP] Avoid Hungarian notation in RuleSet

Also improve some names. (This class still in in urgent need
of refactoring to improve type safety and make clear naming
easier.)

Part of #756

Author: oliverklee

src/RuleSet/RuleSet.php

@@ -25,6 +25,8 @@
 abstract class RuleSet implements Renderable, Commentable
 {
     /**
+     * the rules in this rule set, using the property or rule name as the key
+     *
      * @var array<string, Rule>
      */
     private $rules = [];
@@ -69,9 +71,9 @@ public static function parseRuleSet(ParserState $parserState, RuleSet $ruleSet):
                     $rule = Rule::parse($parserState);
                 } catch (UnexpectedTokenException $e) {
                     try {
-                        $sConsume = $parserState->consumeUntil(["\n", ';', '}'], true);
+                        $consumedText = $parserState->consumeUntil(["\n", ';', '}'], true);
                         // We need to “unfind” the matches to the end of the ruleSet as this will be matched later
-                        if ($parserState->streql(\substr($sConsume, -1), '}')) {
+                        if ($parserState->streql(\substr($consumedText, -1), '}')) {
                             $parserState->backtrack(1);
                         } else {
                             while ($parserState->comes(';')) {
@@ -101,33 +103,33 @@ public function getLineNo(): int
         return $this->lineNumber;
     }
 
-    public function addRule(Rule $rule, ?Rule $sibling = null): void
+    public function addRule(Rule $ruleToAdd, ?Rule $sibling = null): void
     {
-        $sRule = $rule->getRule();
-        if (!isset($this->rules[$sRule])) {
-            $this->rules[$sRule] = [];
+        $propertyOrRuleName = $ruleToAdd->getRule();
+        if (!isset($this->rules[$propertyOrRuleName])) {
+            $this->rules[$propertyOrRuleName] = [];
         }
 
-        $position = \count($this->rules[$sRule]);
+        $position = \count($this->rules[$propertyOrRuleName]);
 
         if ($sibling !== null) {
-            $iSiblingPos = \array_search($sibling, $this->rules[$sRule], true);
-            if ($iSiblingPos !== false) {
-                $position = $iSiblingPos;
-                $rule->setPosition($sibling->getLineNo(), $sibling->getColNo() - 1);
+            $siblingPosition = \array_search($sibling, $this->rules[$propertyOrRuleName], true);
+            if ($siblingPosition !== false) {
+                $position = $siblingPosition;
+                $ruleToAdd->setPosition($sibling->getLineNo(), $sibling->getColNo() - 1);
             }
         }
-        if ($rule->getLineNo() === 0 && $rule->getColNo() === 0) {
+        if ($ruleToAdd->getLineNo() === 0 && $ruleToAdd->getColNo() === 0) {
             //this node is added manually, give it the next best line
             $rules = $this->getRules();
-            $pos = \count($rules);
-            if ($pos > 0) {
-                $last = $rules[$pos - 1];
-                $rule->setPosition($last->getLineNo() + 1, 0);
+            $rulesCount = \count($rules);
+            if ($rulesCount > 0) {
+                $last = $rules[$rulesCount - 1];
+                $ruleToAdd->setPosition($last->getLineNo() + 1, 0);
             }
         }
 
-        \array_splice($this->rules[$sRule], $position, 0, [$rule]);
+        \array_splice($this->rules[$propertyOrRuleName], $position, 0, [$ruleToAdd]);
     }
 
     /**
@@ -153,17 +155,18 @@ public function getRules($searchPattern = null)
         }
         /** @var array<int, Rule> $result */
         $result = [];
-        foreach ($this->rules as $sName => $rules) {
+        foreach ($this->rules as $propertyOrRuleName => $rule) {
             // Either no search rule is given or the search rule matches the found rule exactly
             // or the search rule ends in “-” and the found rule starts with the search rule.
             if (
-                !$searchPattern || $sName === $searchPattern
+                !$searchPattern || $propertyOrRuleName === $searchPattern
                 || (
                     \strrpos($searchPattern, '-') === \strlen($searchPattern) - \strlen('-')
-                    && (\strpos($sName, $searchPattern) === 0 || $sName === \substr($searchPattern, 0, -1))
+                    && (\strpos($propertyOrRuleName, $searchPattern) === 0
+                        || $propertyOrRuleName === \substr($searchPattern, 0, -1))
                 )
             ) {
-                $result = \array_merge($result, $rules);
+                $result = \array_merge($result, $rule);
             }
         }
         \usort($result, static function (Rule $first, Rule $second): int {
@@ -172,6 +175,7 @@ public function getRules($searchPattern = null)
             }
             return $first->getLineNo() - $second->getLineNo();
         });
+
         return $result;
     }
 
@@ -230,26 +234,27 @@ public function getRulesAssoc($searchPattern = null)
     public function removeRule($searchPattern): void
     {
         if ($searchPattern instanceof Rule) {
-            $sRule = $searchPattern->getRule();
-            if (!isset($this->rules[$sRule])) {
+            $propertyToRemove = $searchPattern->getRule();
+            if (!isset($this->rules[$propertyToRemove])) {
                 return;
             }
-            foreach ($this->rules[$sRule] as $key => $rule) {
+            foreach ($this->rules[$propertyToRemove] as $key => $rule) {
                 if ($rule === $searchPattern) {
-                    unset($this->rules[$sRule][$key]);
+                    unset($this->rules[$propertyToRemove][$key]);
                 }
             }
         } else {
-            foreach ($this->rules as $sName => $rules) {
+            foreach ($this->rules as $propertyOrRuleName => $rules) {
                 // Either no search rule is given or the search rule matches the found rule exactly
                 // or the search rule ends in “-” and the found rule starts with the search rule or equals it
                 // (without the trailing dash).
                 if (
-                    !$searchPattern || $sName === $searchPattern
+                    !$searchPattern || $propertyOrRuleName === $searchPattern
                     || (\strrpos($searchPattern, '-') === \strlen($searchPattern) - \strlen('-')
-                        && (\strpos($sName, $searchPattern) === 0 || $sName === \substr($searchPattern, 0, -1)))
+                        && (\strpos($propertyOrRuleName, $searchPattern) === 0
+                            || $propertyOrRuleName === \substr($searchPattern, 0, -1)))
                 ) {
-                    unset($this->rules[$sName]);
+                    unset($this->rules[$propertyOrRuleName]);
                 }
             }
         }
@@ -273,10 +278,10 @@ protected function renderRules(OutputFormat $outputFormat)
         $nextLevelFormat = $outputFormat->nextLevel();
         foreach ($this->rules as $rules) {
             foreach ($rules as $rule) {
-                $sRendered = $nextLevelFormat->safely(static function () use ($rule, $nextLevelFormat): string {
+                $renderedRule = $nextLevelFormat->safely(static function () use ($rule, $nextLevelFormat): string {
                     return $rule->render($nextLevelFormat);
                 });
-                if ($sRendered === null) {
+                if ($renderedRule === null) {
                     continue;
                 }
                 if ($isFirst) {
@@ -285,7 +290,7 @@ protected function renderRules(OutputFormat $outputFormat)
                 } else {
                     $result .= $nextLevelFormat->spaceBetweenRules();
                 }
-                $result .= $sRendered;
+                $result .= $renderedRule;
             }
         }