[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.482% (+0.5%) from 57.935%
when pulling d433854 on bugfix/comma
into 6dec68e 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

oliverklee · 2025-06-29T09:17:54Z

This PR now needs a rebase.

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

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

oliverklee · 2025-06-30T13:46:28Z

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

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

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-08T00:47:04Z

... consumeUntil() bug, and construct tests which exhibit the latter.

#1320

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

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

sabberworm · 2025-07-08T06:31:31Z

src/RuleSet/DeclarationBlock.php

+                            $parserState->consume(1);
+                            $consumedNextCharacter = true;
+                        }
+                        break;
                }
            } while (!\in_array($nextCharacter, ['{', '}'], true) || \is_string($stringWrapperCharacter));


The isset($stringWrapperCharacter) and \is_string($stringWrapperCharacter) are both checking the same thing, right? If so, maybe settle on using one of the two.

It was changed to is_string in a pre-PR, but I forgot to update it in this.

Sorted. It's reassuring to have two reviewers pick up on the same issue :)

CHANGELOG.md

oliverklee · 2025-07-08T08:07:02Z

src/RuleSet/DeclarationBlock.php

+                    $selectorParts[] = $parserState->consume(1);
+                }
+                $selectorParts[] = $parserState->consumeUntil(
+                    ['{', '}', '\'', '"', '(', ')', ','],


To make this easier to understand, I propose moving this array either to a class constant or a well-named local variable. WDYT?

Perhaps a local variable, as it's only applicable to this method. It also matches all the cases in the switch statement. ({ and } could be handled as switch cases rather than by the while, but it's clearer that these are loop end cases the way it's currently written.)

src/RuleSet/DeclarationBlock.php

oliverklee · 2025-07-08T08:09:37Z

src/RuleSet/DeclarationBlock.php

@@ -58,9 +69,31 @@ public static function parse(ParserState $parserState, ?CSSList $list = null): ?
                            }
                        }
                        break;
+                    case '(':
+                        if (!isset($stringWrapperCharacter)) {


We can convert all those to is_string.

Yes, I forgot to update this after making the change in the pre-PR.

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

oliverklee · 2025-07-08T15:55:09Z

tests/Unit/RuleSet/DeclarationBlockTest.php

+        $subject = DeclarationBlock::parse(new ParserState($selector . '{}', Settings::create()));
+
+        $resultSelectorStrings = \array_map(
+            static function (Selector $selectorObject): string {


We have this two times now - so I'd like to propose we move this to a well-named private method.

Good spot. As a stickler for code re-use, I can't believe I missed this. Sorted.

JakeQZ · 2025-07-09T02:37:09Z

I've addressed all comments so far. But I think there's a bit of a "smell" in the tests which have "parses and returns" in a single test.

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

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

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

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

[BUGFIX] Allow comma-separated arguments in selectors

4df6b74

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

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

Don't consume character after , without checking

ad21c3d

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

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

sabberworm reviewed Jul 8, 2025

View reviewed changes

sabberworm approved these changes Jul 8, 2025

View reviewed changes

oliverklee requested changes Jul 8, 2025

View reviewed changes

Fix typo in CHANGELOG.md

0ac639b

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

oliverklee reviewed Jul 8, 2025

View reviewed changes

JakeQZ added 3 commits July 9, 2025 02:08

Add local static for stop characters

873085a

Use is_string throughout, not isset

1f9fcef

Add internal test method to convert arrays of Selectors to strings

d433854

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

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

Are you sure you want to change the base?

[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!

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!

Uh oh!

Uh oh!

oliverklee commented Jun 29, 2025

Uh oh!

JakeQZ commented Jun 30, 2025

Uh oh!

oliverklee commented Jun 30, 2025

Uh oh!

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!

JakeQZ commented Jul 8, 2025

Uh oh!

JakeQZ commented Jul 8, 2025

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!

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!

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 commented Jul 9, 2025

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