Skip to content

[TASK] Move getAllValues() to CSSBlockList #1240

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
Apr 10, 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
26 changes: 26 additions & 0 deletions src/CSSList/CSSBlockList.php
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,32 @@ public function getAllRuleSets(): array
return $result;
}

/**
* Returns all `Value` objects found recursively in `Rule`s in the tree.
*
* @param CSSElement|string $element
* the `CSSList` or `RuleSet` to start the search from (defaults to the whole document).
* If a string is given, it is used as rule name filter.
* @param bool $searchInFunctionArguments whether to also return Value objects used as Function arguments.
*
* @return array<int, Value>
*
* @see RuleSet->getRules()
*/
public function getAllValues($element = null, bool $searchInFunctionArguments = false): array
{
$searchString = null;
if ($element === null) {
$element = $this;
} elseif (\is_string($element)) {
$searchString = $element;
$element = $this;
}
$result = [];
$this->allValues($element, $result, $searchString, $searchInFunctionArguments);
return $result;
}

/**
* @param CSSElement|string $element
* @param list<Value> $result
Expand Down
30 changes: 0 additions & 30 deletions src/CSSList/Document.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@

namespace Sabberworm\CSS\CSSList;

use Sabberworm\CSS\CSSElement;
use Sabberworm\CSS\OutputFormat;
use Sabberworm\CSS\Parsing\ParserState;
use Sabberworm\CSS\Parsing\SourceException;
use Sabberworm\CSS\Property\Selector;
use Sabberworm\CSS\RuleSet\RuleSet;
use Sabberworm\CSS\Value\Value;

/**
* This class represents the root of a parsed CSS file. It contains all top-level CSS contents: mostly declaration
Expand All @@ -31,33 +28,6 @@ public static function parse(ParserState $parserState): Document
return $document;
}

/**
* Returns all `Value` objects found recursively in `Rule`s in the tree.
*
* @param CSSElement|string $element
* the `CSSList` or `RuleSet` to start the search from (defaults to the whole document).
* If a string is given, it is used as rule name filter.
* @param bool $searchInFunctionArguments whether to also return Value objects used as Function arguments.
*
* @return array<int, Value>
*
* @see RuleSet->getRules()
*/
public function getAllValues($element = null, bool $searchInFunctionArguments = false): array
{
$searchString = null;
if ($element === null) {
$element = $this;
} elseif (\is_string($element)) {
$searchString = $element;
$element = $this;
}
/** @var array<int, Value> $result */
$result = [];
$this->allValues($element, $result, $searchString, $searchInFunctionArguments);
return $result;
}

/**
* Returns all `Selector` objects with the requested specificity found recursively in the tree.
*
Expand Down
195 changes: 195 additions & 0 deletions tests/Unit/CSSList/CSSBlockListTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,13 @@
use Sabberworm\CSS\Property\Charset;
use Sabberworm\CSS\Property\Import;
use Sabberworm\CSS\Renderable;
use Sabberworm\CSS\Rule\Rule;
use Sabberworm\CSS\RuleSet\AtRuleSet;
use Sabberworm\CSS\RuleSet\DeclarationBlock;
use Sabberworm\CSS\Tests\Unit\CSSList\Fixtures\ConcreteCSSBlockList;
use Sabberworm\CSS\Value\CSSFunction;
use Sabberworm\CSS\Value\CSSString;
use Sabberworm\CSS\Value\Size;
use Sabberworm\CSS\Value\URL;

/**
Expand Down Expand Up @@ -276,4 +279,196 @@ public function getAllRuleSetsIgnoresCharset(): void

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

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

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

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

$value = new CSSString('Superfont');

$declarationBlock = new DeclarationBlock();
$rule = new Rule('font-family');
$rule->setValue($value);
$declarationBlock->addRule($rule);
$subject->setContents([$declarationBlock]);

$result = $subject->getAllValues();

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

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

$value1 = new CSSString('Superfont');
$value2 = new CSSString('aquamarine');

$declarationBlock = new DeclarationBlock();
$rule1 = new Rule('font-family');
$rule1->setValue($value1);
$declarationBlock->addRule($rule1);
$rule2 = new Rule('color');
$rule2->setValue($value2);
$declarationBlock->addRule($rule2);
$subject->setContents([$declarationBlock]);

$result = $subject->getAllValues();

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

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

$value1 = new CSSString('Superfont');
$value2 = new CSSString('aquamarine');

$declarationBlock1 = new DeclarationBlock();
$rule1 = new Rule('font-family');
$rule1->setValue($value1);
$declarationBlock1->addRule($rule1);
$declarationBlock2 = new DeclarationBlock();
$rule2 = new Rule('color');
$rule2->setValue($value2);
$declarationBlock2->addRule($rule2);
$subject->setContents([$declarationBlock1, $declarationBlock2]);

$result = $subject->getAllValues();

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

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

$value = new CSSString('Superfont');

$declarationBlock = new DeclarationBlock();
$rule = new Rule('font-family');
$rule->setValue($value);
$declarationBlock->addRule($rule);
$atRuleBlockList = new AtRuleBlockList('media');
$atRuleBlockList->setContents([$declarationBlock]);
$subject->setContents([$atRuleBlockList]);

$result = $subject->getAllValues();

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

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

$value1 = new CSSString('Superfont');
$value2 = new CSSString('aquamarine');

$declarationBlock1 = new DeclarationBlock();
$rule1 = new Rule('font-family');
$rule1->setValue($value1);
$declarationBlock1->addRule($rule1);
$declarationBlock2 = new DeclarationBlock();
$rule2 = new Rule('color');
$rule2->setValue($value2);
$declarationBlock2->addRule($rule2);
$subject->setContents([$declarationBlock1, $declarationBlock2]);

$result = $subject->getAllValues($declarationBlock1);

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

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

$value1 = new CSSString('Superfont');
$value2 = new CSSString('aquamarine');

$declarationBlock = new DeclarationBlock();
$rule1 = new Rule('font-family');
$rule1->setValue($value1);
$declarationBlock->addRule($rule1);
$rule2 = new Rule('color');
$rule2->setValue($value2);
$declarationBlock->addRule($rule2);
$subject->setContents([$declarationBlock]);

$result = $subject->getAllValues('font-');

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

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

$value1 = new Size(10, 'px');
$value2 = new Size(2, '%');

$declarationBlock = new DeclarationBlock();
$rule = new Rule('margin');
$rule->setValue(new CSSFunction('max', [$value1, $value2]));
$declarationBlock->addRule($rule);
$subject->setContents([$declarationBlock]);

$result = $subject->getAllValues();

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

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

$value1 = new Size(10, 'px');
$value2 = new Size(2, '%');

$declarationBlock = new DeclarationBlock();
$rule = new Rule('margin');
$rule->setValue(new CSSFunction('max', [$value1, $value2]));
$declarationBlock->addRule($rule);
$subject->setContents([$declarationBlock]);

$result = $subject->getAllValues(null, true);

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