Skip to content

[console] Add truncate method to FormatterHelper #16652

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

Closed
marek-pietrzak-tg wants to merge 6 commits into from
Closed

[console] Add truncate method to FormatterHelper #16652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
61697fa
[console] Add truncate method to FormatterHelper
marek-pietrzak-tg Nov 24, 2015
3f09dfd
Fix cs
marek-pietrzak-tg Nov 24, 2015
1ebdb08
Add multi byte check for string length
marek-pietrzak-tg Nov 24, 2015
afef6da
Use $this->strlen
marek-pietrzak-tg Nov 24, 2015
08e9dd4
Use mb_detect_encoding for charset
marek-pietrzak-tg Dec 18, 2015
2ba4a11
Update CHANGELOG.md
marek-pietrzak-tg Jan 5, 2016
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
5 changes: 5 additions & 0 deletions src/Symfony/Component/Console/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
CHANGELOG
=========

3.1.0
-----

* added truncate method to FormatterHelper

2.8.0
-----

Expand Down
24 changes: 24 additions & 0 deletions src/Symfony/Component/Console/Helper/FormatterHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,30 @@ public function formatBlock($messages, $style, $large = false)
return implode("\n", $messages);
}

/**
* Truncates a message to the given length.
*
* @param string $message
* @param int $length
* @param string $suffix
*
* @return string
*/
public function truncate($message, $length, $suffix = '...')
{
$computedLength = $length - $this->strlen($suffix);

if ($computedLength > $this->strlen($message)) {
return $message;
}

if (false === $encoding = mb_detect_encoding($message, null, true)) {
return substr($message, 0, $length).$suffix;
}

return mb_substr($message, 0, $length, $encoding).$suffix;
}

/**
* {@inheritdoc}
*/
Expand Down
36 changes: 36 additions & 0 deletions src/Symfony/Component/Console/Tests/Helper/FormatterHelperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,40 @@ public function testFormatBlockLGEscaping()
'::formatBlock() escapes \'<\' chars'
);
}

public function testTruncatingWithShorterLengthThanMessageWithSuffix()
{
$formatter = new FormatterHelper();
$message = 'testing truncate';

$this->assertSame('test...', $formatter->truncate($message, 4));
$this->assertSame('testing truncat...', $formatter->truncate($message, 15));
$this->assertSame('testing truncate...', $formatter->truncate($message, 16));
$this->assertSame('zażółć gęślą...', $formatter->truncate('zażółć gęślą jaźń', 12));
}

public function testTruncatingMessageWithCustomSuffix()
{
$formatter = new FormatterHelper();
$message = 'testing truncate';

$this->assertSame('test!', $formatter->truncate($message, 4, '!'));
}

public function testTruncatingWithLongerLengthThanMessageWithSuffix()
{
$formatter = new FormatterHelper();
$message = 'test';

$this->assertSame($message, $formatter->truncate($message, 10));
}

public function testTruncatingWithNegativeLength()
{
$formatter = new FormatterHelper();
$message = 'testing truncate';

$this->assertSame('testing tru...', $formatter->truncate($message, -5));
$this->assertSame('...', $formatter->truncate($message, -100));
}
}