[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: 56.703% (-1.2%) from 57.935%
when pulling 6974745 on task/declarationblock-delegate-ruleset
into 1d8b855 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.

This covers the maniplation of `Rule`s within the container, and may be implemented by other classes in future (e.g. #1194). Note that the naming is consistent with the current codebase, rather than what the CSS entities are now called: - `Rule` represents what is now called a "declaration"; - `RuleSet` represents what is now called a "declaration block"; - `DeclarationBlock` represents what is now called a "style rule"; - `CSSListItem` represents what is now generically called a "rule". Renaming things is part of a longer-term plan touched on in #1189.

This covers the maniplation of `Rule`s within the container, and may be implemented by other classes in future (e.g. #1194). Note that the naming is consistent with the current codebase, rather than what the CSS entities are now called: - `Rule` represents what is now called a "declaration"; - `RuleSet` represents what is now called a "declaration block"; - `DeclarationBlock` represents what is now called a "style rule"; - `CSSListItem` (closely) represents what is now generically called a "rule". Renaming things is part of a longer-term plan touched on in #1189.

JakeQZ · 2025-05-09T23:49:08Z

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

#1256.

This covers the maniplation of `Rule`s within the container, and may be implemented by other classes in future (e.g. #1194). Note that the naming is consistent with the current codebase, rather than what the CSS entities are now called: - `Rule` represents what is now called a "declaration"; - `RuleSet` represents what is now called a "declaration block"; - `DeclarationBlock` represents what is now called a "style rule"; - `CSSListItem` (closely) represents what is now generically called a "rule". Renaming things is part of a longer-term plan touched on in #1189.

The trait provides tests for classes implementing `RuleContainer`. The test methods and data providers have been moved verbatim to the trait from `RuleSetTest`. Will be needed for #1194.

The trait provides tests for classes implementing `RuleContainer`. The test methods and data providers have been moved verbatim to the trait from `RuleSetTest`. Will be needed for #1194

JakeQZ · 2025-06-27T14:26:18Z

I think all pre-PRs that can be separated have been completed now.

oliverklee · 2025-06-28T19:12:13Z

src/RuleSet/RuleSet.php

 */
-abstract class RuleSet implements CSSElement, CSSListItem, Positionable, RuleContainer
+class RuleSet implements CSSElement, CSSListItem, Positionable, RuleContainer


I think we can move the changes to RuleSet (plus test coverage) to a pre-patch, too.

src/RuleSet/DeclarationBlock.php

tests/ParserTest.php

tests/Unit/RuleSet/DeclarationBlockTest.php

... 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.

Use it in the `TestCase`s for `RuleSet` and `DeclarationBlock`.

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 May 9, 2025

[TASK] Add interface RuleContainer for RuleSet #1256

Merged

JakeQZ mentioned this pull request May 12, 2025

Rename getLineNo() to getLineNumber() #974

Closed

22 tasks

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch from 4b3466d to 9db9e2f Compare June 4, 2025 22:11

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch 2 times, most recently from a9790f1 to e123988 Compare June 26, 2025 21:40

JakeQZ mentioned this pull request Jun 26, 2025

[TASK] Add RuleContainerTest trait, use in RuleSetTest #1291

Merged

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch from 61d3317 to 17885d0 Compare June 27, 2025 12:37

JakeQZ marked this pull request as ready for review June 27, 2025 14:26

JakeQZ requested review from oliverklee and sabberworm June 27, 2025 14:26

oliverklee requested changes Jun 28, 2025

View reviewed changes

JakeQZ added 9 commits June 30, 2025 01:41

Add RuleContainer interface for RuleSet and DeclarationBlock

f4d56d2

Change default $lineNumber to null.

d1ef7d3

Restore "represents" in DocBlock description

d97d3cf

Add trait for testing RuleContainer methods

1b55fb2

Use it in the `TestCase`s for `RuleSet` and `DeclarationBlock`.

Update class diagram for DeclarationBlock implementing RuleContainer

50edde7

Add tests for getRuleSet

b1b8a8f

Add changelog entry

85e547c

Reorder construction

6974745

JakeQZ force-pushed the task/declarationblock-delegate-ruleset branch from bcf5cbe to 6974745 Compare June 30, 2025 00:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

Uh oh!

JakeQZ commented Mar 19, 2025

Uh oh!

coveralls commented Mar 19, 2025 •

edited

Loading

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

Uh oh!

Uh oh!

Uh oh!

oliverklee commented May 9, 2025

Uh oh!

JakeQZ commented May 9, 2025

Uh oh!

JakeQZ commented Jun 27, 2025

Uh oh!

oliverklee Jun 28, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[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 May 9, 2025

Uh oh!

JakeQZ commented Jun 27, 2025

Uh oh!

oliverklee Jun 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

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