[CLEANUP] Avoid Hungarian notation in `RuleSet` #1004

oliverklee · 2025-02-26T10:31:11Z

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

oliverklee · 2025-02-26T12:08:35Z

I'm not sure about the naming at all and would appreciate a critical eye (and suggestions).

coveralls · 2025-02-26T16:08:34Z

coverage: 54.598% (-0.06%) from 54.655%
when pulling 52846cb on cleanup/hungarian/ruleset
into 9192d95 on main.

JakeQZ

I can only see one improvement on naming. W3C have changed the names of the abstract concepts over time, which has left us with some class names that no longer correspond.

src/RuleSet/RuleSet.php

JakeQZ

I may have missed some changes in previous review. I've suggested a few more naming improvements.

JakeQZ · 2025-02-27T09:58:34Z

src/RuleSet/RuleSet.php

+            $rulesCount = \count($rules);
+            if ($rulesCount > 0) {
+                $last = $rules[$rulesCount - 1];


The local $rulesCount is probably unnecessary here, since count is atomic (!== [] might be possible if the type of $rules can be guaranteed to be an array), and end() could be used to access the last element. But that's beyond the scope of this PR.

Indeed! I've created #1015 to track this.

JakeQZ · 2025-02-27T09:58:50Z

src/RuleSet/RuleSet.php

        }
        /** @var array<int, Rule> $result */
        $result = [];
-        foreach ($this->aRules as $sName => $aRules) {
+        foreach ($this->rules as $ruleName => $rule) {


Should we use $propertyName here instead of $ruleName?

JakeQZ · 2025-02-27T10:04:40Z

src/RuleSet/RuleSet.php

@@ -222,34 +223,34 @@ public function getRulesAssoc($mRule = null)
     * Note: this is different from pre-v.2.0 behaviour of PHP-CSS-Parser, where passing a Rule instance would
     * remove all rules with the same name. To get the old behaviour, use `removeRule($rule->getRule())`.
     *
-     * @param Rule|string|null $mRule
+     * @param Rule|string|null $removalPattern


I think I would prefer $searchPattern again here. The rules to be removed still have to be searched for.

JakeQZ · 2025-02-27T10:06:40Z

src/RuleSet/RuleSet.php

@@ -222,34 +223,34 @@ public function getRulesAssoc($mRule = null)
     * Note: this is different from pre-v.2.0 behaviour of PHP-CSS-Parser, where passing a Rule instance would
     * remove all rules with the same name. To get the old behaviour, use `removeRule($rule->getRule())`.
     *
-     * @param Rule|string|null $mRule
+     * @param Rule|string|null $removalPattern
     *        pattern to remove. If $mRule is null, all rules are removed. If the pattern ends in a dash,


This mentions the parameter by name, and would also need updating. Though could perhaps be modified to avoid being self-referential.

JakeQZ · 2025-02-27T10:12:12Z

src/RuleSet/RuleSet.php

-            $sRule = $mRule->getRule();
-            if (!isset($this->aRules[$sRule])) {
+        if ($removalPattern instanceof Rule) {
+            $removalRule = $removalPattern->getRule();


Maybe $propertyToRemove instead of $removalRule.

oliverklee · 2025-02-27T10:36:01Z

Updated and repushed.

JakeQZ

Might have been better to have this PR in more manageable chunks. But we are where we are, and we are nearly there.

I found one more variable that could be better-renamed.

JakeQZ · 2025-02-27T11:26:43Z

src/RuleSet/RuleSet.php

                }
            }
        } else {
-            foreach ($this->aRules as $sName => $aRules) {
+            foreach ($this->rules as $ruleName => $rules) {


$propertyName rather than $ruleName

Actaully I'm not sure.

If it's not a nested RuleSet then 'property name' is correct. But I'm not sure otherwise. Perhaps $propertyOrRuleName may be better throughout.

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

oliverklee · 2025-02-27T12:13:55Z

Okay, I'll split this up.

oliverklee added the cleanup label Feb 26, 2025

oliverklee added this to the 9.0.0: Drop support for PHP < 7.2 and clean up things milestone Feb 26, 2025

oliverklee requested a review from JakeQZ February 26, 2025 10:31

oliverklee self-assigned this Feb 26, 2025

oliverklee force-pushed the cleanup/hungarian/ruleset branch from 9cf23ca to 51331a3 Compare February 26, 2025 18:39

JakeQZ requested changes Feb 27, 2025

View reviewed changes

src/RuleSet/RuleSet.php Outdated Show resolved Hide resolved

oliverklee mentioned this pull request Feb 27, 2025

Rename Rule.rule to Rule.propertyName #1011

Open

oliverklee force-pushed the cleanup/hungarian/ruleset branch from 51331a3 to 4a7d4cd Compare February 27, 2025 08:39

oliverklee requested a review from JakeQZ February 27, 2025 08:40

oliverklee force-pushed the cleanup/hungarian/ruleset branch from 4a7d4cd to 9dc285e Compare February 27, 2025 09:36

JakeQZ requested changes Feb 27, 2025

View reviewed changes

oliverklee mentioned this pull request Feb 27, 2025

Simplify RuleSet::addRule() #1015

Open

oliverklee requested a review from JakeQZ February 27, 2025 10:36

oliverklee force-pushed the cleanup/hungarian/ruleset branch 2 times, most recently from 7d8c5a4 to 76753c6 Compare February 27, 2025 11:18

JakeQZ requested changes Feb 27, 2025

View reviewed changes

oliverklee force-pushed the cleanup/hungarian/ruleset branch from 29f1010 to 5fd54e3 Compare February 27, 2025 11:44

oliverklee requested a review from JakeQZ February 27, 2025 11:44

oliverklee added 3 commits February 27, 2025 13:11

[CLEANUP] Avoid Hungarian notation in RuleSet

cc1fb67

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

Changes suggested in code review

686e9db

Implement more suggestions from code review

f60f089

oliverklee force-pushed the cleanup/hungarian/ruleset branch from 5fd54e3 to 3fb7d71 Compare February 27, 2025 12:11

More renaming

52846cb

oliverklee force-pushed the cleanup/hungarian/ruleset branch from 3fb7d71 to 52846cb Compare February 27, 2025 12:13

oliverklee marked this pull request as draft February 27, 2025 12:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CLEANUP] Avoid Hungarian notation in `RuleSet` #1004

[CLEANUP] Avoid Hungarian notation in `RuleSet` #1004

oliverklee commented Feb 26, 2025

oliverklee commented Feb 26, 2025

coveralls commented Feb 26, 2025 •

edited

Loading

JakeQZ left a comment

JakeQZ left a comment

JakeQZ Feb 27, 2025

oliverklee Feb 27, 2025

JakeQZ Feb 27, 2025

JakeQZ Feb 27, 2025

JakeQZ Feb 27, 2025

JakeQZ Feb 27, 2025

oliverklee commented Feb 27, 2025

JakeQZ left a comment

JakeQZ Feb 27, 2025

JakeQZ Feb 27, 2025

JakeQZ Feb 27, 2025

oliverklee commented Feb 27, 2025

[CLEANUP] Avoid Hungarian notation in RuleSet #1004

Are you sure you want to change the base?

[CLEANUP] Avoid Hungarian notation in RuleSet #1004

Conversation

oliverklee commented Feb 26, 2025

oliverklee commented Feb 26, 2025

coveralls commented Feb 26, 2025 • edited Loading

JakeQZ left a comment

Choose a reason for hiding this comment

JakeQZ left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oliverklee commented Feb 27, 2025

JakeQZ left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oliverklee commented Feb 27, 2025

[CLEANUP] Avoid Hungarian notation in `RuleSet` #1004

[CLEANUP] Avoid Hungarian notation in `RuleSet` #1004

coveralls commented Feb 26, 2025 •

edited

Loading