Skip to content

[TASK] Move up getAllRuleSets to CSSBlockList #1047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/CSSList/CSSBlockList.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,19 @@ protected function allDeclarationBlocks(array &$result): void
}
}

/**
* Returns all `RuleSet` objects recursively found in the tree, no matter how deeply nested the rule sets are.
*
* @return array<int, RuleSet>
*/
public function getAllRuleSets(): array
{
/** @var array<int, RuleSet> $result */
$result = [];
$this->allRuleSets($result);
return $result;
}

/**
* @param array<int, RuleSet> $result
*/
Expand Down
13 changes: 0 additions & 13 deletions src/CSSList/Document.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,6 @@ public static function parse(ParserState $parserState): Document
return $oDocument;
}

/**
* Returns all `RuleSet` objects recursively found in the tree, no matter how deeply nested the rule sets are.
*
* @return array<int, RuleSet>
*/
public function getAllRuleSets(): array
{
/** @var array<int, RuleSet> $result */
$result = [];
$this->allRuleSets($result);
return $result;
}

/**
* Returns all `Value` objects found recursively in `Rule`s in the tree.
*
Expand Down
137 changes: 137 additions & 0 deletions tests/Unit/CSSList/CSSBlockListTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use Sabberworm\CSS\Property\Charset;
use Sabberworm\CSS\Property\Import;
use Sabberworm\CSS\Renderable;
use Sabberworm\CSS\RuleSet\AtRuleSet;
use Sabberworm\CSS\RuleSet\DeclarationBlock;
use Sabberworm\CSS\Tests\Unit\CSSList\Fixtures\ConcreteCSSBlockList;
use Sabberworm\CSS\Value\CSSString;
Expand Down Expand Up @@ -139,4 +140,140 @@ public function getAllDeclarationBlocksIgnoresCharset(): void

self::assertSame([], $result);
}

/**
* @test
*/
public function getAllRuleSetsWhenNoContentSetReturnsEmptyArray(): void
{
$subject = new ConcreteCSSBlockList();

self::assertSame([], $subject->getAllRuleSets());
}

/**
* @test
*/
public function getAllRuleSetsReturnsOneDeclarationBlockDirectlySetAsContent(): void
{
$subject = new ConcreteCSSBlockList();

$declarationBlock = new DeclarationBlock();
$subject->setContents([$declarationBlock]);

$result = $subject->getAllRuleSets();

self::assertSame([$declarationBlock], $result);
}

/**
* @test
*/
public function getAllRuleSetsReturnsOneAtRuleSetDirectlySetAsContent(): void
{
$subject = new ConcreteCSSBlockList();

$atRuleSet = new AtRuleSet('media');
$subject->setContents([$atRuleSet]);

$result = $subject->getAllRuleSets();

self::assertSame([$atRuleSet], $result);
}

/**
* @test
*/
public function getAllRuleSetsReturnsMultipleDeclarationBlocksDirectlySetAsContents(): void
{
$subject = new ConcreteCSSBlockList();

$declarationBlock1 = new DeclarationBlock();
$declarationBlock2 = new DeclarationBlock();
$subject->setContents([$declarationBlock1, $declarationBlock2]);

$result = $subject->getAllRuleSets();

self::assertSame([$declarationBlock1, $declarationBlock2], $result);
}

/**
* @test
*/
public function getAllRuleSetsReturnsMultipleAtRuleSetsDirectlySetAsContents(): void
{
$subject = new ConcreteCSSBlockList();

$atRuleSet1 = new AtRuleSet('media');
$atRuleSet2 = new AtRuleSet('media');
$subject->setContents([$atRuleSet1, $atRuleSet2]);

$result = $subject->getAllRuleSets();

self::assertSame([$atRuleSet1, $atRuleSet2], $result);
}

/**
* @test
*/
public function getAllRuleSetsReturnsDeclarationBlocksWithinAtRuleBlockList(): void
{
$subject = new ConcreteCSSBlockList();

$declarationBlock = new DeclarationBlock();
$atRuleBlockList = new AtRuleBlockList('media');
$atRuleBlockList->setContents([$declarationBlock]);
$subject->setContents([$atRuleBlockList]);

$result = $subject->getAllRuleSets();

self::assertSame([$declarationBlock], $result);
}

/**
* @test
*/
public function getAllRuleSetsReturnsAtRuleSetsWithinAtRuleBlockList(): void
{
$subject = new ConcreteCSSBlockList();

$atRule = new AtRuleSet('media');
$atRuleBlockList = new AtRuleBlockList('media');
$atRuleBlockList->setContents([$atRule]);
$subject->setContents([$atRuleBlockList]);

$result = $subject->getAllRuleSets();

self::assertSame([$atRule], $result);
}

/**
* @test
*/
public function getAllRuleSetsIgnoresImport(): void
{
$subject = new ConcreteCSSBlockList();

$import = new Import(new URL(new CSSString('https://www.example.com/')), '');
$subject->setContents([$import]);

$result = $subject->getAllRuleSets();

self::assertSame([], $result);
}

/**
* @test
*/
public function getAllRuleSetsIgnoresCharset(): void
{
$subject = new ConcreteCSSBlockList();

$charset = new Charset(new CSSString('UTF-8'));
$subject->setContents([$charset]);

$result = $subject->getAllRuleSets();

self::assertSame([], $result);
}
}
143 changes: 0 additions & 143 deletions tests/Unit/CSSList/DocumentTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,10 @@

use PHPUnit\Framework\TestCase;
use Sabberworm\CSS\Comment\Commentable;
use Sabberworm\CSS\CSSList\AtRuleBlockList;
use Sabberworm\CSS\CSSList\CSSBlockList;
use Sabberworm\CSS\CSSList\CSSList;
use Sabberworm\CSS\CSSList\Document;
use Sabberworm\CSS\Property\Charset;
use Sabberworm\CSS\Property\Import;
use Sabberworm\CSS\Renderable;
use Sabberworm\CSS\RuleSet\AtRuleSet;
use Sabberworm\CSS\RuleSet\DeclarationBlock;
use Sabberworm\CSS\Value\CSSString;
use Sabberworm\CSS\Value\URL;

/**
* @covers \Sabberworm\CSS\CSSList\CSSBlockList
Expand Down Expand Up @@ -61,142 +54,6 @@ public function isCSSList(): void
self::assertInstanceOf(CSSList::class, $subject);
}

/**
* @test
*/
public function getAllRuleSetsWhenNoContentSetReturnsEmptyArray(): void
{
$subject = new Document();

self::assertSame([], $subject->getAllRuleSets());
}

/**
* @test
*/
public function getAllRuleSetsReturnsOneDeclarationBlockDirectlySetAsContent(): void
{
$subject = new Document();

$declarationBlock = new DeclarationBlock();
$subject->setContents([$declarationBlock]);

$result = $subject->getAllRuleSets();

self::assertSame([$declarationBlock], $result);
}

/**
* @test
*/
public function getAllRuleSetsReturnsOneAtRuleSetDirectlySetAsContent(): void
{
$subject = new Document();

$atRuleSet = new AtRuleSet('media');
$subject->setContents([$atRuleSet]);

$result = $subject->getAllRuleSets();

self::assertSame([$atRuleSet], $result);
}

/**
* @test
*/
public function getAllRuleSetsReturnsMultipleDeclarationBlocksDirectlySetAsContents(): void
{
$subject = new Document();

$declarationBlock1 = new DeclarationBlock();
$declarationBlock2 = new DeclarationBlock();
$subject->setContents([$declarationBlock1, $declarationBlock2]);

$result = $subject->getAllRuleSets();

self::assertSame([$declarationBlock1, $declarationBlock2], $result);
}

/**
* @test
*/
public function getAllRuleSetsReturnsMultipleAtRuleSetsDirectlySetAsContents(): void
{
$subject = new Document();

$atRuleSet1 = new AtRuleSet('media');
$atRuleSet2 = new AtRuleSet('media');
$subject->setContents([$atRuleSet1, $atRuleSet2]);

$result = $subject->getAllRuleSets();

self::assertSame([$atRuleSet1, $atRuleSet2], $result);
}

/**
* @test
*/
public function getAllRuleSetsReturnsDeclarationBlocksWithinAtRuleBlockList(): void
{
$subject = new Document();

$declarationBlock = new DeclarationBlock();
$atRuleBlockList = new AtRuleBlockList('media');
$atRuleBlockList->setContents([$declarationBlock]);
$subject->setContents([$atRuleBlockList]);

$result = $subject->getAllRuleSets();

self::assertSame([$declarationBlock], $result);
}

/**
* @test
*/
public function getAllRuleSetsReturnsAtRuleSetsWithinAtRuleBlockList(): void
{
$subject = new Document();

$atRule = new AtRuleSet('media');
$atRuleBlockList = new AtRuleBlockList('media');
$atRuleBlockList->setContents([$atRule]);
$subject->setContents([$atRuleBlockList]);

$result = $subject->getAllRuleSets();

self::assertSame([$atRule], $result);
}

/**
* @test
*/
public function getAllRuleSetsIgnoresImport(): void
{
$subject = new Document();

$import = new Import(new URL(new CSSString('https://www.example.com/')), '');
$subject->setContents([$import]);

$result = $subject->getAllRuleSets();

self::assertSame([], $result);
}

/**
* @test
*/
public function getAllRuleSetsIgnoresCharset(): void
{
$subject = new Document();

$charset = new Charset(new CSSString('UTF-8'));
$subject->setContents([$charset]);

$result = $subject->getAllRuleSets();

self::assertSame([], $result);
}

/**
* @test
*/
Expand Down