[BUGFIX] Allow comma-separated arguments in selectors #1292

JakeQZ · 2025-06-28T03:10:36Z

Fixes #138.
Fixes #360.
Fixes #1289.

coveralls · 2025-06-28T03:12:16Z

coverage: 58.906% (+0.3%) from 58.615%
when pulling 0612c65 on bugfix/comma
into 931c406 on main.

JakeQZ · 2025-06-28T03:26:49Z

This is rough and ready, though fixes #1289. I have no idea why an additional fix for comment parsing seems to be required.

I expect judicious review, and that this PR needs to be split because of the curious comment-parsing bug (why is nothing ever easy?). Anyhow, we're on the road to sorting this.

src/RuleSet/DeclarationBlock.php

oliverklee · 2025-06-28T08:01:17Z

src/Parsing/ParserState.php

@@ -345,6 +345,10 @@ public function consumeUntil(
        $start = $this->currentPosition;

        while (!$this->isEnd()) {
+            $comment = $this->consumeComment();


We should cover this with a test.

Yeah, it's a bit mysterious why the bug this is fixing suddenly reared it's head with this change. Will need investigating as a separate issue.

So how should we proceed here? Fix that bug first and then continue here? Or merge this PR first and than fix that bug (and cover it with tests)?

I tend to prefer the first, but am not completely sure.

WDYT?

The comment parsing bugfix seems to be needed for this PR (though I don't yet understand why), so it would need to be done first if it really is required for this change to work.

src/Property/Selector.php

- Assign the result of `ParserState::peek()` to a local variable, for efficiency; - Use a switch statement to branch on its value, for extensibility (e.g. #1292); - Don't unnecessarily test that a quote character is not escaped when not within a string.

CHANGELOG.md

JakeQZ · 2025-06-30T00:26:32Z

This PR now needs a rebase.

Apart from that, is it ready for a re-review, or does it need any other changes first?

Have rebased. The mysterious issue with comment consumption still needs to be resolved...

JakeQZ · 2025-07-07T22:57:48Z

About the commit message: The Fixes #xxxx comments needs to be on a separate line each ticket ID for the auto-closing to work.

It the docs are correct, they can be on the same line, but do need to be written out individually. However, I think it's more readable if they are on separate lines, given the format I originally used won't work. I've amended the original commit.

JakeQZ · 2025-07-07T23:31:56Z

The mysterious issue with comment consumption still needs to be resolved...

I've found that this arose because this PR changes consumption behaviour to consume the first character after the selector separator (,), regardless of what it is, which is a currently a mistake in this PR that needs to be addressed.

The "Number 4" comment (here) is then the next thing consumeUntil() reads.

It so happens that there is a space after the comma, which if not pre-consumed, would allow consumeUntil() to consume the comment at the end of the loop. So I think it will be possible to complete this PR without addressing the consumeUntil() bug, and construct tests which exhibit the latter.

JakeQZ · 2025-07-08T01:46:21Z

I've found that this arose because this PR changes consumption behaviour to consume the first character after the selector separator (,), regardless of what it is, which is a currently a mistake in this PR that needs to be addressed.

This is now fixed.

I think the DeclarationBlock::parse method could be refactored to be broken down into separate methods, but since this a backporting candidate, I'd rather do that later.

I think it would be possible to apply the change regarding , handling as a separate pre-PR cleanup, without the fix for bracket handling. See what you think...

src/RuleSet/DeclarationBlock.php

oliverklee · 2025-07-09T13:42:22Z

I'm increasingly thinking this would be a good approach, if only to separate the changes into manageable chunks.

I'm confused - "this" (the good approach) is "having one more pre-patch" or "merging this PR first and then having a follow-up PR"?

JakeQZ · 2025-07-09T14:59:58Z

I'm increasingly thinking this would be a good approach, if only to separate the changes into manageable chunks.

I'm confused - "this" (the good approach) is "having one more pre-patch" or "merging this PR first and then having a follow-up PR"?

Having another pre-PR to move the splitting of separators at commas into parse(). Then this PR will just be the bugfix to not split them when they are inside function arguments.

... in `DeclarationBlock::parse()`. This improves readability in preparation for #1292 which will extend the list. (It may also slightly improve performance.)

JakeQZ · 2025-07-09T18:13:29Z

Having another pre-PR to move the splitting of separators at commas into parse(). Then this PR will just be the bugfix to not split them when they are inside function arguments.

The introduction of $stopCharacters can also be a separate pre-PR: #1321.

... in `DeclarationBlock::parse()`. This improves readability in preparation for #1292 which will extend the list. (It may also slightly improve performance.)

The tests broadly cover what currently works, and will be extended to cover the fixes in #1292.

JakeQZ · 2025-07-09T21:27:09Z

I think there's a bit of a "smell" in the tests which have "parses and returns" in a single test.

I've dealt with the "smell". The tests are for parsing. So I've renamed the methods and structured them into 'set up', 'run test', 'check results' on that basis in #1322 as another pre-PR.

The tests broadly cover what currently works, and will be extended to cover the fixes in #1292.

JakeQZ · 2025-07-09T23:23:57Z

I think it would be possible to apply the change regarding , handling as a separate pre-PR cleanup, without the fix for bracket handling.

Indeed it is, and this fixes a separate bug: #1323.

Fixes #138. Fixes #360. Fixes #1289.

Also remove fix for `consumeUntil` bug, which #1320 will address.

Co-authored-by: Oliver Klee <[email protected]>

(Can succinct be used as a verb? The typo in 'correctly' vanishes.)

JakeQZ · 2025-07-10T09:07:38Z

Pre-PRs are all done. This is ready for final review.

src/RuleSet/DeclarationBlock.php

Also reject selectors with unclosed parentheses.

- Assign the result of `ParserState::peek()` to a local variable, for efficiency; - Use a switch statement to branch on its value, for extensibility (e.g. #1292); - Don't unnecessarily test that a quote character is not escaped when not within a string.

... in `DeclarationBlock::parse()`. This improves readability in preparation for #1292 which will extend the list. (It may also slightly improve performance.)

The tests broadly cover what currently works, and will be extended to cover the fixes in #1292.

This is the backport of #1292 and releated changes.

JakeQZ added this to the 8.9.0: Deprecations and bug fixes milestone Jun 28, 2025

JakeQZ requested review from sabberworm and oliverklee June 28, 2025 03:10

JakeQZ self-assigned this Jun 28, 2025

JakeQZ added bug to-backport labels Jun 28, 2025

JakeQZ force-pushed the bugfix/comma branch 2 times, most recently from 8626ec3 to 5705132 Compare June 28, 2025 05:41

oliverklee reviewed Jun 28, 2025

View reviewed changes

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

oliverklee requested changes Jun 28, 2025

View reviewed changes

JakeQZ mentioned this pull request Jun 28, 2025

[CLEANUP] Tidy up DeclarationBlock::parse() #1294

Merged

JakeQZ force-pushed the bugfix/comma branch from 5705132 to ef431d7 Compare June 29, 2025 00:02

oliverklee reviewed Jun 29, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

JakeQZ force-pushed the bugfix/comma branch from 6f93bcc to 11776b0 Compare June 30, 2025 00:24

This comment was marked as resolved.

Sign in to view

JakeQZ force-pushed the bugfix/comma branch from 11776b0 to 4df6b74 Compare July 7, 2025 22:51

JakeQZ mentioned this pull request Jul 8, 2025

ParserState::consumeUntil() fails if comment comes immediately next #1320

Open

This comment was marked as resolved.

Sign in to view

JakeQZ requested a review from oliverklee July 8, 2025 01:46

sabberworm reviewed Jul 8, 2025

View reviewed changes

src/RuleSet/DeclarationBlock.php Show resolved Hide resolved

sabberworm approved these changes Jul 8, 2025

View reviewed changes

JakeQZ requested a review from oliverklee July 9, 2025 02:37

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

[CLEANUP] Use static variable for stop characters

2024d46

... in `DeclarationBlock::parse()`. This improves readability in preparation for #1292 which will extend the list. (It may also slightly improve performance.)

JakeQZ mentioned this pull request Jul 9, 2025

[CLEANUP] Use static variable for stop characters #1321

Merged

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

[TASK] Add unit tests for selector parsing

aea4b9b

The tests broadly cover what currently works, and will be extended to cover the fixes in #1292.

JakeQZ mentioned this pull request Jul 9, 2025

[TASK] Add unit tests for selector parsing #1322

Merged

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

[TASK] Add unit tests for selector parsing (#1322)

595a47b

The tests broadly cover what currently works, and will be extended to cover the fixes in #1292.

JakeQZ mentioned this pull request Jul 9, 2025

Refactor DeclarationBlock::parse() #1324

Open

JakeQZ and others added 4 commits July 10, 2025 09:41

[BUGFIX] Allow comma-separated arguments in selectors

0425f1e

Fixes #138. Fixes #360. Fixes #1289.

Don't consume character after , without checking

7a06c91

Also remove fix for `consumeUntil` bug, which #1320 will address.

Fix typo in CHANGELOG.md

18756bf

Co-authored-by: Oliver Klee <[email protected]>

Succinct changelog entry

4fa98e3

(Can succinct be used as a verb? The typo in 'correctly' vanishes.)

JakeQZ force-pushed the bugfix/comma branch from d433854 to 4fa98e3 Compare July 10, 2025 09:02

oliverklee reviewed Jul 10, 2025

View reviewed changes

src/RuleSet/DeclarationBlock.php Show resolved Hide resolved

Test rejection of selectors with unmatched parentheses

0612c65

Also reject selectors with unclosed parentheses.

JakeQZ force-pushed the bugfix/comma branch from 0d4486b to 0612c65 Compare July 10, 2025 11:14

oliverklee approved these changes Jul 10, 2025

View reviewed changes

oliverklee merged commit d856c3a into main Jul 10, 2025
21 checks passed

oliverklee deleted the bugfix/comma branch July 10, 2025 11:24

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

[CLEANUP] Use static variable for stop characters (#1321)

7bd3fb2

... in `DeclarationBlock::parse()`. This improves readability in preparation for #1292 which will extend the list. (It may also slightly improve performance.)

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

[TASK] Add unit tests for selector parsing (#1322)

b9e3deb

The tests broadly cover what currently works, and will be extended to cover the fixes in #1292.

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

[BUGFIX] Allow comma-separated arguments in selectors

d56fd85

This is the backport of #1292 and releated changes.

JakeQZ mentioned this pull request Jul 11, 2025

Please Release Me #1326

Open

[BUGFIX] Allow comma-separated arguments in selectors #1292

[BUGFIX] Allow comma-separated arguments in selectors #1292

Uh oh!

Conversation

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

JakeQZ commented Jun 28, 2025

Uh oh!

Uh oh!

Uh oh!

oliverklee Jun 28, 2025

Choose a reason for hiding this comment

Uh oh!

JakeQZ Jun 28, 2025

Choose a reason for hiding this comment

Uh oh!

oliverklee Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

JakeQZ Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

JakeQZ commented Jun 30, 2025

Uh oh!

This comment was marked as resolved.

JakeQZ commented Jul 7, 2025

Uh oh!

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

Uh oh!

Uh oh!

This comment was marked as resolved.

JakeQZ commented Jul 8, 2025

Uh oh!

Uh oh!

oliverklee commented Jul 9, 2025

Uh oh!

JakeQZ commented Jul 9, 2025

Uh oh!

JakeQZ commented Jul 9, 2025

Uh oh!

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

Uh oh!

Uh oh!

JakeQZ commented Jul 9, 2025

Uh oh!

JakeQZ commented Jul 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JakeQZ commented Jun 28, 2025 •

edited

Loading

coveralls commented Jun 28, 2025 •

edited

Loading

JakeQZ commented Jul 7, 2025 •

edited

Loading

JakeQZ commented Jul 9, 2025 •

edited

Loading