Renaming my String class to CompressedString to avoid any PHP 7 issues.

Author: orware

README.md

@@ -22,9 +22,9 @@ Usage
 
 It's primarily intended to be used in a write forward way (primarily because going back to the beginning of a gzip string requires it to be decoded, so prepending should be discouraged from excessive use), but you do have the option to prepend text when needed:
 ```php
-use Orware\Compressed\String;
+use Orware\Compressed\CompressedString;
 
-$compressedString = new String();
+$compressedString = new CompressedString();
 
 // You may write multiple times:
 $content = 'The quick brown fox jumps over the lazy dog';
@@ -33,7 +33,7 @@ $compressedString->write($content);
 $moreContent = 'The quick brown fox jumps over the lazy dog';
 $compressedString->write($moreContent);
 
-// You can prepend text as well 
+// You can prepend text as well
 // (currently this involves creating a new stream, adding the prepended text, then copying the existing stream into the new stream):
 $textToPrepend = 'PREPENDED';
 $compressedString->prepend($textToPrepend);
@@ -59,38 +59,37 @@ $compressedString->writeCompressedContents('tests/files/appended_test_compressed
 
 There's also the ability to merge in one or more compressed strings into a "wrapper" string. In my case my wrapper contained some metadata about the JSON results.
 ```php
-use Orware\Compressed\String;
-use Orware\Compressed\StringList;
-use Orware\Compressed\StringMerge;
+use Orware\Compressed\CompressedString;
+use Orware\Compressed\CompressedStringList;
 
-$compressedString1 = new String();
+$compressedString1 = new CompressedString();
 $content = 'My first string';
 $compressedString1->write($content);
 
-$compressedString2 = new String();
+$compressedString2 = new CompressedString();
 $content = 'My second string';
 $compressedString2->write($content);
 
-$compressedString3 = new String();
+$compressedString3 = new CompressedString();
 $content = 'My third string';
 $compressedString3->write($content);
 
 // You must use this StringList class (it's what the merge call below expects):
-$list = new StringList();
+$list = new CompressedStringList();
 
 $list->enqueue($compressedString1);
 $list->enqueue($compressedString2);
 $list->enqueue($compressedString3);
 
-// The default placeholder is #|_|# 
+// The default placeholder is #|_|#
 // Each instance of that placeholder below will get replaced:
 $subject = '{"string1":"#|_|#","string2":"#|_|#","string3":"#|_|#"}';
 
 // The end result is a new compressed string.
-// Depending on the size of your compressed strings execution 
-// time may go up during a merge since each has to be decoded 
+// Depending on the size of your compressed strings execution
+// time may go up during a merge since each has to be decoded
 // and compressed again when merged into the new string.
-$mergedString = StringMerge::merge($subject, '#|_|#', $list);
+$mergedString = CompressedStringList::merge($subject, '#|_|#', $list);
 
 ```
 

src/String.php renamed to src/CompressedString.php

@@ -7,7 +7,7 @@
 use GuzzleHttp\Psr7\Stream;
 use GuzzleHttp\Psr7\StreamWrapper;
 
-class String
+class CompressedString
 {
     protected $gzStream = null;
     protected $stream = null;

src/CompressedStringList.php

@@ -0,0 +1,58 @@
+<?php
+namespace Orware\Compressed;
+
+class CompressedStringList
+{
+    protected $queue = null;
+
+    public function __construct()
+    {
+        $this->queue = new \SplQueue();
+        $this->queue->setIteratorMode(\SplDoublyLinkedList::IT_MODE_FIFO | \SplDoublyLinkedList::IT_MODE_DELETE);
+    }
+
+	public static function merge($subject, $delimiter, CompressedStringList $gzippedStrings)
+    {
+        if (!is_string($subject)) {
+            $subject = json_encode($subject);
+        }
+
+        $subjectParts = explode($delimiter, $subject);
+
+        $merged = new CompressedString();
+
+        foreach ($subjectParts as $part) {
+            $merged->write($part);
+            if (!$gzippedStrings->isEmpty()) {
+                $string = $gzippedStrings->dequeue();
+
+                $readStream = $string->getReadOnlyStream();
+                while ($buffer = $readStream->read(4096)) {
+                    $merged->write($buffer);
+                }
+            }
+        }
+
+        return $merged;
+    }
+
+    public function enqueue(CompressedString $string)
+    {
+        return $this->queue->enqueue($string);
+    }
+
+    public function dequeue()
+    {
+        return $this->queue->dequeue();
+    }
+
+    public function isEmpty()
+    {
+        return $this->queue->isEmpty();
+    }
+
+    public function count()
+    {
+        return $this->queue->count();
+    }
+}

src/StringList.php

@@ -1,9 +1,9 @@
 <?php
-use Orware\Compressed\String;
-use Orware\Compressed\StringList;
+use Orware\Compressed\CompressedString;
+use Orware\Compressed\CompressedStringList;
 use Orware\Compressed\StringMerge;
 
-class StringMergeTest extends \PHPUnit_Framework_TestCase
+class CompressedStringMergeTest extends \PHPUnit_Framework_TestCase
 {
     public function memoryUsage($method, $stage = '')
     {
@@ -26,27 +26,27 @@ public function testMerge()
     {
         $this->memoryUsage(__METHOD__, '');
 
-        $compressedString1 = new String();
+        $compressedString1 = new CompressedString();
         $content = 'My first string';
         $compressedString1->write($content);
 
-        $compressedString2 = new String();
+        $compressedString2 = new CompressedString();
         $content = 'My second string';
         $compressedString2->write($content);
 
-        $compressedString3 = new String();
+        $compressedString3 = new CompressedString();
         $content = 'My third string';
         $compressedString3->write($content);
 
-        $list = new StringList();
+        $list = new CompressedStringList();
 
         $list->enqueue($compressedString1);
         $list->enqueue($compressedString2);
         $list->enqueue($compressedString3);
 
         $subject = '{"string1":"#|_|#","string2":"#|_|#","string3":"#|_|#"}';
 
-        $mergedString = StringMerge::merge($subject, '#|_|#', $list);
+        $mergedString = CompressedStringList::merge($subject, '#|_|#', $list);
 
         $expected = '{"string1":"My first string","string2":"My second string","string3":"My third string"}';
         $this->assertEquals($expected, $mergedString->getDecompressedContents());
@@ -56,7 +56,7 @@ public function testLargeMergeIntoString()
     {
         $this->memoryUsage(__METHOD__, 'Start');
 
-        $compressedString1 = new String();
+        $compressedString1 = new CompressedString();
         $handle = fopen('tests/files/companies_first_10.json', "r");
         if ($handle) {
             while (($buffer = fgets($handle, 4096)) !== false) {
@@ -66,7 +66,7 @@ public function testLargeMergeIntoString()
             fclose($handle);
         }
 
-        $compressedString2 = new String();
+        $compressedString2 = new CompressedString();
         $handle = fopen('tests/files/companies_first_10.json', "r");
         if ($handle) {
             while (($buffer = fgets($handle, 4096)) !== false) {
@@ -78,12 +78,12 @@ public function testLargeMergeIntoString()
 
         $subject = '[{"queryType":"SELECT","rowCount":4178,"executionTimeMilliseconds":4764.52,"executionTimeSeconds":4.76,"memoryUsageBytes":323344,"memoryUsageMegabytes":0.31,"cachedResponse":false,"data":#|_|#,"error":false},{"queryType":"SELECT","rowCount":4178,"executionTimeMilliseconds":4764.52,"executionTimeSeconds":4.76,"memoryUsageBytes":323344,"memoryUsageMegabytes":0.31,"cachedResponse":false,"data":#|_|#,"error":false}]';
 
-        $list = new StringList();
+        $list = new CompressedStringList();
 
         $list->enqueue($compressedString1);
         $list->enqueue($compressedString2);
 
-        $mergedString = StringMerge::merge($subject, '#|_|#', $list);
+        $mergedString = CompressedStringList::merge($subject, '#|_|#', $list);
 
         $this->log("Merged String Size is: " . $mergedString->getCompressedSize());
 
@@ -99,7 +99,7 @@ public function testLargeMergeIntoObject()
     {
         $this->memoryUsage(__METHOD__, 'Start');
 
-        $compressedString1 = new String();
+        $compressedString1 = new CompressedString();
         $handle = fopen('tests/files/companies_first_10.json', "r");
         if ($handle) {
             while (($buffer = fgets($handle, 4096)) !== false) {
@@ -109,7 +109,7 @@ public function testLargeMergeIntoObject()
             fclose($handle);
         }
 
-        $compressedString2 = new String();
+        $compressedString2 = new CompressedString();
         $handle = fopen('tests/files/companies_first_10.json', "r");
         if ($handle) {
             while (($buffer = fgets($handle, 4096)) !== false) {
@@ -146,12 +146,12 @@ public function testLargeMergeIntoObject()
 
         $subject[] = $queryObject2;
 
-        $list = new StringList();
+        $list = new CompressedStringList();
 
         $list->enqueue($compressedString1);
         $list->enqueue($compressedString2);
 
-        $mergedString = StringMerge::merge($subject, '#|_|#', $list);
+        $mergedString = CompressedStringList::merge($subject, '#|_|#', $list);
 
         // Actual size should be less than 80,000 bytes:
         $this->assertLessThanOrEqual(80000, $mergedString->getCompressedSize());

src/StringMerge.php

@@ -1,7 +1,7 @@
 <?php
-use Orware\Compressed\String;
+use Orware\Compressed\CompressedString;
 
-class StringTest extends \PHPUnit_Framework_TestCase
+class CompressedStringTest extends \PHPUnit_Framework_TestCase
 {
     /*public function testReadStream()
     {
@@ -30,7 +30,7 @@ public function log($string, $newline = true)
 
     public function testWriteStream()
     {
-        $compressedString = new String();
+        $compressedString = new CompressedString();
 
         $content = 'The quick brown fox jumps over the lazy dog';
         $compressedString->write($content);
@@ -40,7 +40,7 @@ public function testWriteStream()
 
     public function testMixedWriteStream()
     {
-        $compressedString = new String();
+        $compressedString = new CompressedString();
 
         $content = 'The quick brown fox jumps over the lazy dog';
         $compressedString->write($content);
@@ -60,7 +60,7 @@ public function testPrependStream()
     {
         $this->memoryUsage(__METHOD__, 'Start');
 
-        $compressedString = new String();
+        $compressedString = new CompressedString();
 
         $content = 'The quick brown fox jumps over the lazy dog';
         $compressedString->write($content);
@@ -78,7 +78,7 @@ public function testPrependStream()
 
     public function testPrependAndWriteStream()
     {
-        $compressedString = new String();
+        $compressedString = new CompressedString();
 
         $content = 'The quick brown fox jumps over the lazy dog';
         $compressedString->write($content);
@@ -98,10 +98,10 @@ public function testDifferentCompressionModes()
     {
         $content = file_get_contents('README.md');
 
-        $compressedString1 = new String(false, 1);
+        $compressedString1 = new CompressedString(false, 1);
         $compressedString1->write($content);
 
-        $compressedString2 = new String(false, 6);
+        $compressedString2 = new CompressedString(false, 6);
         $compressedString2->write($content);
 
         $size1 = $compressedString1->getCompressedSize();
@@ -118,7 +118,7 @@ public function testDifferentCompressionModes()
     public function testReadGzipFile()
     {
         $this->memoryUsage(__METHOD__, 'Start');
-        $compressedStringFile = new String(true, 6, __DIR__.'/files/companies_first_10.gz');
+        $compressedStringFile = new CompressedString(true, 6, __DIR__.'/files/companies_first_10.gz');
 
         $readOnlyStream = $compressedStringFile->getReadOnlyStream();
         $i = 0;
@@ -141,7 +141,7 @@ public function testWriteFileAndReadStream()
     {
         $this->memoryUsage(__METHOD__, 'Start');
 
-        $compressedString = new String();
+        $compressedString = new CompressedString();
 
         $content = file_get_contents(__DIR__.'/files/companies_first_10.json');
         $compressedString->write($content);