[TASK] Use delegation for `DeclarationBlock` -> `RuleSet` #1194

JakeQZ · 2025-03-19T00:56:25Z

... rather than inheritance.

This will allow DeclarationBlock to instead extend CSSBlockList in order to support
CSS nesting.

This is a slightly-breaking change, since now CSSBlockList::getAllRuleSets() will include the RuleSet property of the DeclarationBlock instead of the DeclarationBlock itself.

Part of #1170.

coveralls · 2025-03-19T00:58:01Z

coverage: 59.595% (-0.2%) from 59.816%
when pulling e666f5e on task/declarationblock-delegate-ruleset
into b2028eb on main.

src/CSSList/CSSList.php

src/RuleSet/DeclarationBlock.php

JakeQZ · 2025-04-15T23:50:25Z

Would be good to resolve #1247 before moving on with this.

JakeQZ · 2025-05-08T22:38:33Z

This is almost ready for review, but some tests need to be added. Before doing so, I'd appreciate a pre-review from you: @sabberworm, @oliverklee.

I'm not keen on the having the various chaining methods in DeclarationBlock, but to avoid breaking changes they are necessary. A trait can be used for testing them in the same way as their counterparts in RuleSet.

For DeclarationBlock to contain nested rules, it needs to extend CSSBlockList. RuleSet cannot be a trait; it needs to be a fully-fledged type for methods like getAllRuleSets().

This is the only realistic way forward I see for now, in an 'Agile' sense, which can deliver what is required now, without wholescale refactoring or breaking changes.

config/phpstan-baseline.neon

oliverklee

I like this approach!

src/CSSList/CSSBlockList.php

src/RuleSet/DeclarationBlock.php

oliverklee · 2025-05-09T18:45:04Z

Maybe as another spin-off PR (or prepatch), we can introduce the interface and have one class implement it.

JakeQZ · 2025-07-18T18:29:11Z

I tried undoing lastest merge, but it's still a mess. I can't even get back to where I was now. Will take some time redoing.

In my experience, when I had a PR from which I spun off some pre-PRs, I also sometimes had nasty merge conflicts when rebasing. In those cases, it made things a lot easier if I squashed the existing commits in the PR branch before rebasing.

I think I have somehow managed to rebase without including any changes from main. So now the diffs are showing that all the changes from main are being reverted. I did git rebase --abort when I got in a muddle.

If I could somehow reset the branch to the state it was in immediately after the commit "Reorder construction", then squashing may be possible, but I'm not sure how to do that.

oliverklee · 2025-07-18T20:12:32Z

If I could somehow reset the branch to the state it was in immediately after the commit "Reorder construction", then squashing may be possible, but I'm not sure how to do that.

git reflog allows you to list all recent commits and which actions lead to them, including rebases, branch switches etc. So this might be helpful. (It has saved my work a couple of times.)

JakeQZ · 2025-07-19T00:54:56Z

If I could somehow reset the branch to the state it was in immediately after the commit "Reorder construction"

git reset -hard {SHA-of-last-commit-before-attempted-rebase}

... undid the failed rebase/merge. I think when I tried merging instead (via GitHub), that moved the 'common ancestor' point, but when I reverted the merge, it was not moved back.

then squashing may be possible, but I'm not sure how to do that.

git reset -soft {SHA-of-first-branch-commit}
git commit --amend

... did the squashing.

In my experience, when I had a PR from which I spun off some pre-PRs, I also sometimes had nasty merge conflicts when rebasing. In those cases, it made things a lot easier if I squashed the existing commits in the PR branch before rebasing.

That helped immensely; thanks. Instead of (presumably) 9 rounds of conflict resolution, including for files with no overall conflict, there was just one round, for the two files that actually had conflicts. (I'm used to Perforce, which does the merge all at once, and also has a visual editor for 3-way merging. Keeping a cool head also helps ;))

Rebase now done !) Thanks <3

oliverklee · 2025-07-19T07:40:53Z

I'm used to Perforce, which does the merge all at once, and also has a visual editor for 3-way merging.

I use PhpStorm as my IDE, and IIRC it also have a nice 3-way-merge UI. (Disclaimer: I don't use UIs for git stuff and hence can only report what I hear and see from other people.)

... adding internal `render` method. Precursor to #1194.

... instead of `getAllRuleSets`. This avoids testing if `RuleSet`s are `DeclarationBlock`s, and will be needed for #1194.

JakeQZ · 2025-07-21T16:56:44Z

I think this is now ready for a final review.

oliverklee · 2025-07-21T20:23:32Z

src/RuleSet/DeclarationBlock.php

@@ -107,7 +132,9 @@ public static function parse(ParserState $parserState, ?CSSList $list = null): ?
            }
        }
        $result->setComments($comments);
-        RuleSet::parseRuleSet($parserState, $result);
+
+        RuleSet::parseRuleSet($parserState, $result->ruleSet);


Even though this technically works, I'd find using the getter getRuleSet() more clean here.

parseRuleSet() takes the RuleSet argument by reference, in order to fill it in with the the parsed Rules, so the class property needs to be passed.

As far as I understand it, getRuleSet() returns the instance, not a clone of it.

(PHP by default passes object kind-of-by-reference. I explained this on page 17 of my diploma thesis back then.)

You're right. I was thinking of arrays (even though I knew it was an object - my thinking cap must have been on back-to-front). Thanks for the thesis link; I will give it a read some time...

oliverklee · 2025-07-21T20:25:14Z

src/RuleSet/DeclarationBlock.php

+     */
+    public function __construct(?int $lineNumber = null)
+    {
+        $this->ruleSet = new RuleSet($lineNumber);


We also need unit tests that the created RuleSet uses has line number from the DeclarationBlock constructor, and that it defaults to null.

We don't appear to have an existing test that RuleSet applies the line number provided, so perhaps another pre-PR is needed...

#1348 for RuleSet. Once that is approved, I can address this along similar lines.

Have added tests to cover:

getLineNumber() returning line number passed to DeclarationBlock constructor (or null by default);

getRuleSet()->getLineNumber() returning line number passed to DeclarationBlock constructor (or null by default);

But perhaps 1 could be covered by another pre-PR...

#1350 for item 1.

oliverklee · 2025-07-21T20:26:37Z

src/RuleSet/DeclarationBlock.php

@@ -175,6 +202,73 @@ public function getSelectors(): array
        return $this->selectors;
    }

+    public function getRuleSet(): RuleSet


We should have unit tests for the added methods.

getRuleSet() has some tests added for it. The methods that chain on to the equivalent RuleSet method have tests added via the RuleContainerTest trait (which is also used in the test case for RuleSet). So I think all the added methods have test coverage.

... rather than inheritance. This will allow `DeclarationBlock` to instead extend `CSSBlockList` in order to support [CSS nesting](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_nesting). This is a slightly-breaking change, since now `CSSBlockList::getAllRuleSets()` will include the `RuleSet` property of the `DeclarationBlock` instead of the `DeclarationBlock` itself. Part of #1170.

…RuleSet()`

JakeQZ · 2025-07-24T18:32:53Z

This issues from the last review should all now be resolved.

JakeQZ added cleanup css4 Relating to features introduced in CSS4 labels Mar 19, 2025

JakeQZ added this to the 9.0.0: Drop support for PHP < 7.2 and clean up things milestone Mar 19, 2025

JakeQZ self-assigned this Mar 19, 2025

JakeQZ marked this pull request as draft March 19, 2025 00:56

JakeQZ mentioned this pull request Mar 19, 2025

Add support for nested selectors #1170

Open

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch from 7800603 to 73956e9 Compare March 19, 2025 02:06

oliverklee reviewed Mar 19, 2025

View reviewed changes

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

oliverklee reviewed Mar 19, 2025

View reviewed changes

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

JakeQZ added css3 and removed css4 Relating to features introduced in CSS4 labels Mar 20, 2025

JakeQZ mentioned this pull request Mar 25, 2025

[TASK] Add trait providing standard implementation of Commentable #1206

Merged

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch 5 times, most recently from c1c27a9 to 3a278e0 Compare April 2, 2025 00:31

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch 5 times, most recently from c935f2c to 1f908cf Compare April 14, 2025 15:25

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch from 1f908cf to 1ce18b7 Compare May 6, 2025 17:40

JakeQZ commented May 8, 2025

View reviewed changes

config/phpstan-baseline.neon Outdated Show resolved Hide resolved

oliverklee reviewed May 9, 2025

View reviewed changes

src/CSSList/CSSBlockList.php Outdated Show resolved Hide resolved

oliverklee reviewed May 9, 2025

View reviewed changes

src/RuleSet/DeclarationBlock.php Show resolved Hide resolved

JakeQZ mentioned this pull request Jul 18, 2025

[TASK] Make RuleSet concrete #1341

Merged

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch 3 times, most recently from 184f865 to 34c8708 Compare July 19, 2025 00:22

oliverklee pushed a commit that referenced this pull request Jul 21, 2025

[TASK] Make RuleSet concrete (#1341)

af6d8c0

... adding internal `render` method. Precursor to #1194.

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch 2 times, most recently from 76f0b5f to 6d615c9 Compare July 21, 2025 14:06

JakeQZ added a commit that referenced this pull request Jul 21, 2025

[CLEANUP] Use getAllDeclarationBlocks in colorParsing test

b97b6e7

... instead of `getAllRuleSets`. This avoids testing if `RuleSet`s are `DeclarationBlock`s, and will be needed for #1194.

JakeQZ mentioned this pull request Jul 21, 2025

[CLEANUP] Use getAllDeclarationBlocks in colorParsing test #1346

Merged

oliverklee pushed a commit that referenced this pull request Jul 21, 2025

[CLEANUP] Use getAllDeclarationBlocks in colorParsing test (#1346)

bb3d342

... instead of `getAllRuleSets`. This avoids testing if `RuleSet`s are `DeclarationBlock`s, and will be needed for #1194.

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch from 6d615c9 to 38c7836 Compare July 21, 2025 16:55

JakeQZ marked this pull request as ready for review July 21, 2025 16:56

JakeQZ requested a review from oliverklee July 21, 2025 16:56

oliverklee requested changes Jul 21, 2025

View reviewed changes

JakeQZ mentioned this pull request Jul 23, 2025

[TASK] Prepare release of version 9.0.0 #1328

Draft

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch from 38c7836 to d6c7420 Compare July 24, 2025 15:45

JakeQZ added 3 commits July 24, 2025 19:24

Add tests for DeclarationBlock constructor in conjunction with `get…

fd6dc73

…RuleSet()`

Use getter to access the RuleSet object property

85dc980

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch from cec8497 to 85dc980 Compare July 24, 2025 18:26

JakeQZ requested a review from oliverklee July 24, 2025 18:32

JakeQZ added 2 commits July 24, 2025 22:08

Allow provideLineNumber() providing null.

2cbadaf

Fix incorrect assert

e666f5e

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch from 9c1c62e to e666f5e Compare July 24, 2025 21:10

[TASK] Use delegation for DeclarationBlock -> RuleSet #1194

Are you sure you want to change the base?

[TASK] Use delegation for DeclarationBlock -> RuleSet #1194

Uh oh!

Conversation

JakeQZ commented Mar 19, 2025

Uh oh!

coveralls commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JakeQZ commented Apr 15, 2025

Uh oh!

JakeQZ commented May 8, 2025

Uh oh!

Uh oh!

oliverklee left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

oliverklee commented May 9, 2025

Uh oh!

JakeQZ commented Jul 18, 2025

Uh oh!

oliverklee commented Jul 18, 2025

Uh oh!

JakeQZ commented Jul 19, 2025

Uh oh!

oliverklee commented Jul 19, 2025

Uh oh!

JakeQZ commented Jul 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oliverklee Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JakeQZ Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JakeQZ commented Jul 24, 2025

Uh oh!

Uh oh!

[TASK] Use delegation for `DeclarationBlock` -> `RuleSet` #1194

[TASK] Use delegation for `DeclarationBlock` -> `RuleSet` #1194

coveralls commented Mar 19, 2025 •

edited

Loading

oliverklee Jul 24, 2025 •

edited

Loading

JakeQZ Jul 22, 2025 •

edited

Loading