Skip to content
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

feat: truncate to length + tests #5

Closed
wants to merge 1 commit into from
Closed

feat: truncate to length + tests #5

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
98 changes: 98 additions & 0 deletions src/SmsLength.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,14 +80,21 @@ class SmsLength
*/
private $messageCount;

/**
* @var string
*/
private $messageContent;

/**
* Constructor
*
* @param string $messageContent SMS message content (UTF-8)
*
* @throws InvalidArgumentException
*/
public function __construct($messageContent)
{
$this->messageContent = $messageContent;
$this->inspect($messageContent);
}

Expand Down Expand Up @@ -121,6 +128,16 @@ public function getMessageCount()
return $this->messageCount;
}

/**
* Get number of message content
*
* @return string
*/
public function getMessageContent()
{
return $this->messageContent;
}

/**
* Get upper breakpoint for the current message count
*
Expand Down Expand Up @@ -157,10 +174,91 @@ public function validate()
return true;
}

/**
* Return a new instance with the message truncated to a set part count
*
* @param int $parts
*
* @return self
*/
public function truncate($parts)
{
if ($this->messageCount <= $parts) {
return $this;
}

if ($this->encoding === '7-bit') {
return new self($this->truncate7Bit($this->messageContent, $parts));
}

return new self($this->truncateUcs2($this->messageContent, $parts));
}

private function truncate7Bit($message, $parts)
{
$size = 0;
$newMessage = '';

$mbLength = mb_strlen($message, 'UTF-8');

for ($i = 0; $i < $mbLength; $i++) {
$char = mb_substr($message, $i, 1, 'UTF-8');

if (in_array($char, self::GSM0338_BASIC)) {
$charSize = 1;
} elseif (in_array($char, self::GSM0338_EXTENDED)) {
$charSize = 2;
} else {
continue;
}

if ($parts === 1 && $size + $charSize > self::MAXIMUM_CHARACTERS_7BIT_SINGLE) {
return $newMessage;
}

if ($parts > 1 && $size + $charSize > $parts * self::MAXIMUM_CHARACTERS_7BIT_CONCATENATED) {
return $newMessage;
}

$size += $charSize;
$newMessage .= $char;
}

return $newMessage;
}

private function truncateUcs2($message, $parts)
{
$size = 0;
$newMessage = '';

$mbLength = mb_strlen($message, 'UTF-8');

for ($i = 0; $i < $mbLength; $i++) {
$char = mb_substr($message, $i, 1, 'UTF-8');
$utf16Hex = bin2hex(mb_convert_encoding($char, 'UTF-16', 'UTF-8'));
$charSize = strlen($utf16Hex) / 4;

if ($parts === 1 && $size + $charSize > self::MAXIMUM_CHARACTERS_UCS2_SINGLE) {
return $newMessage;
}

if ($parts > 1 && $size + $charSize >= $parts * self::MAXIMUM_CHARACTERS_UCS2_CONCATENATED) {
return $newMessage;
}

$size += $charSize;
$newMessage .= $char;
}

return $newMessage;
}

/**
* Parse content to discover size characteristics
*
* @param string $messageContent
*
* @throws InvalidArgumentException
*/
private function inspect($messageContent)
Expand Down
65 changes: 63 additions & 2 deletions tests/SmsLengthTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,17 +90,19 @@ public function providerSize()

/**
* @dataProvider providerTooLarge
*
* @param string $content
* @param string $encoding
* @param int $characters
* @param int $messageCount
* @param int $upperBreak
*
* @medium Expect tests to take >1 but <10
* @expectedException InvalidArgumentException
* @expectedExceptionMessage Message count cannot exceed 255
*/
public function testTooLarge($content, $encoding, $characters, $messageCount, $upperBreak)
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage("Message count cannot exceed 255");
$size = new SmsLength($content);

$this->assertSame($encoding, $size->getEncoding());
Expand Down Expand Up @@ -129,4 +131,63 @@ public function providerTooLarge()
[str_repeat("simple msg plus \xf0\x9f\x93\xb1", 950), 'ucs-2', 17100, 256, 17152]
];
}

/**
* @dataProvider providerTruncate
*/
public function testTruncate($content, $parts, $expected)
{
$original = new SmsLength($content);

$new = $original->truncate($parts);

$this->assertSame($parts, $new->getMessageCount());
$this->assertSame($expected, $new->getMessageContent());
}

public function providerTruncate()
{
return [
'message under one part' => [
'message' => 'La La La',
'parts' => 1,
'expected' => 'La La La',
],
'message over one part, gsm7' => [
'message' => str_repeat('abcd', 45),
'parts' => 1,
'expected' => str_repeat('abcd', 40),
],
'message over two part, gsm7' => [
'message' => str_repeat('abcd', 100),
'parts' => 2,
'expected' => str_repeat('abcd', 76) . 'ab',
],
'message over one part, gsm7 + ext' => [
'message' => str_repeat('abcd[', 30),
'parts' => 1,
'expected' => str_repeat('abcd[', 26) . 'abcd', // each part is 6 chars, should be 26 reps + 4 chars leftover
],
'message over one part, uc2 1 part char' => [
'message' => str_repeat('•', 100),
'parts' => 1,
'expected' => str_repeat('•', 70),
],
'message over one part, uc2 3 byte' => [
'message' => str_repeat('⏩', 100),
'parts' => 1,
'expected' => str_repeat('⏩', 70),
],
'message over one part, uc2 4 byte' => [
'message' => str_repeat('🌐', 100),
'parts' => 1,
'expected' => str_repeat('🌐', 35),
],
'message over two parts, uc2 4 byte' => [
'message' => str_repeat('🌐', 200),
'parts' => 2,
'expected' => str_repeat('🌐', 66),
]
];
}
}