Skip to content

[DomCrawler] normalizeWhitespace should be true by default #34151

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.

Sign up for GitHub

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
Oct 29, 2019
Merged

[DomCrawler] normalizeWhitespace should be true by default #34151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions src/Symfony/Bundle/SecurityBundle/Tests/Functional/CsrfFormLoginTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public function testFormLoginAndLogoutWithCsrfTokens($config)

$crawler = $client->followRedirect();

$text = $crawler->text();
$text = $crawler->text(null, true);
$this->assertStringContainsString('Hello johannes!', $text);
$this->assertStringContainsString('You\'re browsing to path "/profile".', $text);

Expand All @@ -56,7 +56,7 @@ public function testFormLoginWithInvalidCsrfToken($config)

$this->assertRedirect($client->getResponse(), '/login');

$text = $client->followRedirect()->text();
$text = $client->followRedirect()->text(null, true);
$this->assertStringContainsString('Invalid CSRF token.', $text);
}

Expand All @@ -75,7 +75,7 @@ public function testFormLoginWithCustomTargetPath($config)

$this->assertRedirect($client->getResponse(), '/foo');

$text = $client->followRedirect()->text();
$text = $client->followRedirect()->text(null, true);
$this->assertStringContainsString('Hello johannes!', $text);
$this->assertStringContainsString('You\'re browsing to path "/foo".', $text);
}
Expand All @@ -96,7 +96,7 @@ public function testFormLoginRedirectsToProtectedResourceAfterLogin($config)
$client->submit($form);
$this->assertRedirect($client->getResponse(), '/protected-resource');

$text = $client->followRedirect()->text();
$text = $client->followRedirect()->text(null, true);
$this->assertStringContainsString('Hello johannes!', $text);
$this->assertStringContainsString('You\'re browsing to path "/protected-resource".', $text);
}
Expand Down
8 changes: 4 additions & 4 deletions src/Symfony/Bundle/SecurityBundle/Tests/Functional/FormLoginTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public function testFormLogin($config)

$this->assertRedirect($client->getResponse(), '/profile');

$text = $client->followRedirect()->text();
$text = $client->followRedirect()->text(null, true);
$this->assertStringContainsString('Hello johannes!', $text);
$this->assertStringContainsString('You\'re browsing to path "/profile".', $text);
}
Expand All @@ -47,7 +47,7 @@ public function testFormLogout($config)
$this->assertRedirect($client->getResponse(), '/profile');

$crawler = $client->followRedirect();
$text = $crawler->text();
$text = $crawler->text(null, true);

$this->assertStringContainsString('Hello johannes!', $text);
$this->assertStringContainsString('You\'re browsing to path "/profile".', $text);
Expand Down Expand Up @@ -80,7 +80,7 @@ public function testFormLoginWithCustomTargetPath($config)

$this->assertRedirect($client->getResponse(), '/foo');

$text = $client->followRedirect()->text();
$text = $client->followRedirect()->text(null, true);
$this->assertStringContainsString('Hello johannes!', $text);
$this->assertStringContainsString('You\'re browsing to path "/foo".', $text);
}
Expand All @@ -101,7 +101,7 @@ public function testFormLoginRedirectsToProtectedResourceAfterLogin($config)
$client->submit($form);
$this->assertRedirect($client->getResponse(), '/protected_resource');

$text = $client->followRedirect()->text();
$text = $client->followRedirect()->text(null, true);
$this->assertStringContainsString('Hello johannes!', $text);
$this->assertStringContainsString('You\'re browsing to path "/protected_resource".', $text);
}
Expand Down
12 changes: 10 additions & 2 deletions src/Symfony/Component/DomCrawler/Crawler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,7 +593,7 @@ public function nodeName()
/**
* Returns the text of the first node of the list.
*
* Pass true as the 2nd argument to normalize whitespaces.
* Pass true as the second argument to normalize whitespaces.
*
* @param string|null $default When not null: the value to return when the current node is empty
* @param bool $normalizeWhitespace Whether whitespaces should be trimmed and normalized to single spaces
Expand All @@ -602,7 +602,7 @@ public function nodeName()
*
* @throws \InvalidArgumentException When current node is empty
*/
public function text(/* string $default = null, bool $normalizeWhitespace = false */)
public function text(/* string $default = null, bool $normalizeWhitespace = true */)
{
if (!$this->nodes) {
if (0 < \func_num_args() && null !== func_get_arg(0)) {
Expand All @@ -614,6 +614,14 @@ public function text(/* string $default = null, bool $normalizeWhitespace = fals

$text = $this->getNode(0)->nodeValue;

if (\func_num_args() <= 1) {
if (trim(preg_replace('/(?:\s{2,}+|[^\S ])/', ' ', $text)) !== $text) {
@trigger_error(sprintf('"%s()" will normalize whitespaces by default in Symfony 5.0, set the second "$normalizeWhitespace" argument to false to retrieve the non-normalized version of the text.', __METHOD__), E_USER_DEPRECATED);
}

return $text;
}

if (\func_num_args() > 1 && func_get_arg(1)) {
return trim(preg_replace('/(?:\s{2,}+|[^\S ])/', ' ', $text));
}
Expand Down
8 changes: 8 additions & 0 deletions src/Symfony/Component/DomCrawler/Tests/AbstractCrawlerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,14 @@ public function testNormalizeWhiteSpace()
$crawler = $this->createTestCrawler()->filterXPath('//p');
$this->assertSame('Elsa <3', $crawler->text(null, true), '->text(null, true) returns the text with normalized whitespace');
$this->assertNotSame('Elsa <3', $crawler->text(null, false));
}

/**
* @group legacy
*/
public function testLegacyNormalizeWhiteSpace()
{
$crawler = $this->createTestCrawler()->filterXPath('//p');
$this->assertNotSame('Elsa <3', $crawler->text());
}

Expand Down