Fix additional deprecations

Author: Riimu

.github/workflows/main.yml

@@ -23,6 +23,7 @@ jobs:
           php-version: ${{ matrix.php-versions }}
           coverage: none
           tools: phpunit
+          ini-values: error_reporting=E_ALL
       - name: Setup Composer
         uses: ./.github/actions/setup-composer
       - name: Run PHPUnit

.gitignore

@@ -1,5 +1,5 @@
+.phpunit.cache/
 build/
 vendor/
 .php-cs-fixer.cache
-.phpunit.result.cache
 composer.lock

CHANGES.md

@@ -1,5 +1,11 @@
 # Changelog #
 
+## v1.1.4 (2022-01-02) ##
+
+* Improve Github action workflow
+* Fix additional PHP 8.1 deprecations
+* Fix issue with `JsonStream::getContents()` no returning buffer contents
+
 ## v1.1.3 (2021-12-27) ##
 
 * Add support for PHP 8.1

composer.json

@@ -1,22 +1,22 @@
 {
   "name": "violet/streaming-json-encoder",
-  "type": "library",
   "description": "Library for iteratively encoding large JSON documents piece by piece",
-  "homepage": "http://violet.riimu.net",
+  "license": "MIT",
+  "type": "library",
   "keywords": [
     "streaming",
     "json",
     "encoder",
     "psr-7"
   ],
-  "license": "MIT",
   "authors": [
     {
       "name": "Riikka Kalliomäki",
       "email": "[email protected]",
       "homepage": "http://riimu.net"
     }
   ],
+  "homepage": "http://violet.riimu.net",
   "require": {
     "php": ">=5.6.0",
     "psr/http-message": "^1.0"

phpunit.xml

@@ -1,16 +1,26 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="tests/bootstrap.php">
-  <testsuites>
-    <testsuite name="Default">
-      <directory suffix="Test.php">tests/tests/</directory>
-    </testsuite>
-  </testsuites>
-  <filter>
-    <whitelist processUncoveredFilesFromWhitelist="true">
-      <directory suffix=".php">src/</directory>
-      <exclude>
-        <file>src/autoload.php</file>
-      </exclude>
-    </whitelist>
-  </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheResultFile=".phpunit.cache/test-results"
+         executionOrder="depends,defects"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         convertDeprecationsToExceptions="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage cacheDirectory=".phpunit.cache/code-coverage"
+              processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
 </phpunit>

src/JsonStream.php

@@ -261,6 +261,10 @@ public function isReadable()
      */
     public function read($length)
     {
+        if ($this->eof()) {
+            return '';
+        }
+
         $length = max(0, (int) $length);
         $encoder = $this->getEncoder();
 
@@ -288,8 +292,12 @@ public function read($length)
      */
     public function getContents()
     {
+        if ($this->eof()) {
+            return '';
+        }
+
         $encoder = $this->getEncoder();
-        $output = '';
+        $output = $this->buffer;
 
         while ($encoder->valid()) {
             $output .= $encoder->current();

tests/bootstrap.php

@@ -23,6 +23,7 @@ public function __construct($data)
         $this->data = $data;
     }
 
+    #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return $this->data;

tests/classes/SerializableData.php

@@ -139,4 +139,13 @@ public function testPrettyPrintStream()
         $stream = new JsonStream($encoder);
         $this->assertSame("[\n    \"value\"\n]", $stream->getContents());
     }
+
+    public function testGetRemainingContents()
+    {
+        $encoder = (new BufferJsonEncoder(['value']));
+        $stream = new JsonStream($encoder);
+
+        $this->assertSame('["val', $stream->read(5));
+        $this->assertSame('ue"]', $stream->getContents());
+    }
 }