Remove deprecated APIs and mark ZlibFilterStream as internal only

README.md

@@ -15,9 +15,6 @@ supporting compression and decompression of GZIP, ZLIB and raw DEFLATE formats.
 * [Usage](#usage)
     * [Compressor](#compressor)
     * [Decompressor](#decompressor)
-    * [ZlibFilterStream](#zlibfilterstream)
-        * [createCompressor()](#createcompressor)
-        * [createDecompressor()](#createdecompressor)
     * [Inconsistencies](#inconsistencies)
 * [Install](#install)
 * [Tests](#tests)
@@ -137,10 +134,6 @@ $input->pipe($filterBadWords)->pipe($compressor)->pipe($output);
 For more details, see ReactPHP's
 [`DuplexStreamInterface`](https://github.com/reactphp/stream#duplexstreaminterface).
 
->   Internally, it implements the deprecated `ZlibFilterStream` class only for
-    BC reasons. For best forwards compatibility, you should only rely on it
-    implementing the `DuplexStreamInterface`.
-
 ### Decompressor
 
 The `Decompressor` class can be used to decompress a stream of data.
@@ -169,59 +162,6 @@ $input->pipe($decompressor)->pipe($filterBadWords)->pipe($output);
 For more details, see ReactPHP's
 [`DuplexStreamInterface`](https://github.com/reactphp/stream#duplexstreaminterface).
 
->   Internally, it implements the deprecated `ZlibFilterStream` class only for
-    BC reasons. For best forwards compatibility, you should only rely on it
-    implementing the `DuplexStreamInterface`.
-
-### ZlibFilterStream
-
-The deprecated `ZlibFilterStream` is a small wrapper around the underlying `zlib.deflate` and `zlib.inflate`
-stream compression filters offered via `ext-zlib`.
-
-#### createCompressor()
-
-The following deprecated methods can be used to
-create a `Compressor` instance with the respective encoding parameter:
-
-```php
-// deprecated
-$compressor = ZlibFilterStream::createGzipCompressor();
-$compressor = ZlibFilterStream::createDeflateCompressor();
-$compressor = ZlibFilterStream::createZlibCompressor();
-```
-
-Using any of these methods is deprecated.
-Instead, you should explicitly create a `Compressor` like this:
-
-```php
-$encoding = ZLIB_ENCODING_GZIP; // or ZLIB_ENCODING_RAW or ZLIB_ENCODING_DEFLATE
-$compressor = new Clue\React\Zlib\Compressor($encoding);
-```
-
-See also [`Compressor`](#compressor) for more details.
-
-#### createDecompressor()
-
-The following deprecated methods can be used to
-create a `Decompressor` instanceof with the respective encoding parameter:
-
-```php
-// deprecated
-$decompressor = ZlibFilterStream::createGzipDecompressor();
-$decompressor = ZlibFilterStream::createDeflateDecompressor();
-$decompressor = ZlibFilterStream::createZlibDecompressor();
-```
-
-Using any of these methods is deprecated.
-Instead, you should explicitly create a `Decompressor` like this:
-
-```php
-$encoding = ZLIB_ENCODING_GZIP; // or ZLIB_ENCODING_RAW or ZLIB_ENCODING_DEFLATE
-$decompressor = new Clue\React\Zlib\Decompressor($encoding);
-```
-
-See also [`Compressor`](#compressor) for more details.
-
 ### Inconsistencies
 
 The stream compression filters are not exactly the most commonly used features of PHP.

src/Compressor.php

@@ -30,10 +30,6 @@
  *
  * For more details, see ReactPHP's
  * [`DuplexStreamInterface`](https://github.com/reactphp/stream#duplexstreaminterface).
- *
- * >   Internally, it implements the deprecated `ZlibFilterStream` class only for
- *     BC reasons. For best forwards compatibility, you should only rely on it
- *     implementing the `DuplexStreamInterface`.
  */
 final class Compressor extends ZlibFilterStream
 {

src/Decompressor.php

@@ -30,10 +30,6 @@
  *
  * For more details, see ReactPHP's
  * [`DuplexStreamInterface`](https://github.com/reactphp/stream#duplexstreaminterface).
- *
- * >   Internally, it implements the deprecated `ZlibFilterStream` class only for
- *     BC reasons. For best forwards compatibility, you should only rely on it
- *     implementing the `DuplexStreamInterface`.
  */
 final class Decompressor extends ZlibFilterStream
 {

src/ZlibFilterStream.php

@@ -3,75 +3,21 @@
 namespace Clue\React\Zlib;
 
 /**
- * Compressor and decompressor using PHP's zlib compression filters.
+ * [Internal] Compressor and decompressor using PHP's zlib compression filters.
  *
  * Supports the following compression formats:
  *
  * RFC 1952 (GZIP compressed format)
  * RFC 1951 (raw DEFLATE compressed format)
  * RFC 1950 (ZLIB compressed format)
  *
+ * @internal Should not be relied upon outside of this package.
  * @link http://php.net/manual/en/filters.compression.php
- * @deprecated 0.2.2 External usage of `ZlibFilterStream` is deprecated, use `Compressor` or `Decompressor` instead.
  * @see Compressor
  * @see Decompressor
  */
 class ZlibFilterStream extends TransformStream
 {
-    /**
-     * @deprecated
-     * @return self
-     */
-    public static function createGzipCompressor($level = -1)
-    {
-        return new Compressor(ZLIB_ENCODING_GZIP, $level);
-    }
-
-    /**
-     * @deprecated
-     * @return self
-     */
-    public static function createGzipDecompressor()
-    {
-        return new Decompressor(ZLIB_ENCODING_GZIP);
-    }
-
-    /**
-     * @deprecated
-     * @return self
-     */
-    public static function createDeflateCompressor($level = -1)
-    {
-        return new Compressor(ZLIB_ENCODING_RAW, $level);
-    }
-
-    /**
-     * @deprecated
-     * @return self
-     */
-    public static function createDeflateDecompressor()
-    {
-        return new Decompressor(ZLIB_ENCODING_RAW);
-    }
-
-    /**
-     * @deprecated
-     * @return self
-     */
-    public static function createZlibCompressor($level = -1)
-    {
-        return new Compressor(ZLIB_ENCODING_DEFLATE, $level);
-    }
-
-    /**
-     * @deprecated
-     * @return self
-     */
-    public static function createZlibDecompressor()
-    {
-        return new Decompressor(ZLIB_ENCODING_DEFLATE);
-    }
-
     private $filter;
 
     /**

tests/ZlibFilterDeflateDecompressorTest.php → tests/DeflateDecompressorTest.php

@@ -1,14 +1,14 @@
 <?php
 
-use Clue\React\Zlib\ZlibFilterStream;
+use Clue\React\Zlib\Decompressor;
 
-class ZlibFilterDeflateDecompressorTest extends TestCase
+class DeflateDecompressorTest extends TestCase
 {
     private $decompressor;
 
     public function setUp()
     {
-        $this->decompressor = ZlibFilterStream::createDeflateDecompressor();
+        $this->decompressor = new Decompressor(ZLIB_ENCODING_RAW);
     }
 
     public function testInflateEmpty()

tests/ZlibFilterDeflateCompressorTest.php → tests/DelateCompressorTest.php

@@ -1,14 +1,14 @@
 <?php
 
-use Clue\React\Zlib\ZlibFilterStream;
+use Clue\React\Zlib\Compressor;
 
-class ZlibFilterDeflateCompressorTest extends TestCase
+class DeflateCompressorTest extends TestCase
 {
     private $compressor;
 
     public function setUp()
     {
-        $this->compressor = ZlibFilterStream::createDeflateCompressor();
+        $this->compressor = new Compressor(ZLIB_ENCODING_RAW);
     }
 
     public function testDeflateEmpty()

tests/ZlibFilterGzipCompressorTest.php → tests/GzipCompressorTest.php

@@ -1,14 +1,14 @@
 <?php
 
-use Clue\React\Zlib\ZlibFilterStream;
+use Clue\React\Zlib\Compressor;
 
-class ZlibFilterGzipCompressorTest extends TestCase
+class GzipCompressorTest extends TestCase
 {
     private $compressor;
 
     public function setUp()
     {
-        $this->compressor = ZlibFilterStream::createGzipCompressor();
+        $this->compressor = new Compressor(ZLIB_ENCODING_GZIP);
     }
 
     public function testCompressEmpty()

tests/ZlibFilterGzipDecompressorTest.php → tests/GzipDecompressorTest.php

@@ -1,14 +1,14 @@
 <?php
 
-use Clue\React\Zlib\ZlibFilterStream;
+use Clue\React\Zlib\Decompressor;
 
-class ZlibFilterGzipDecompressorTest extends TestCase
+class GzipDecompressorTest extends TestCase
 {
     private $decompressor;
 
     public function setUp()
     {
-        $this->decompressor = ZlibFilterStream::createGzipDecompressor();
+        $this->decompressor = new Decompressor(ZLIB_ENCODING_GZIP);
     }
 
     public function testDecompressEmpty()

tests/ZlibFilterZlibCompressorTest.php → tests/ZlibCompressorTest.php

@@ -1,14 +1,14 @@
 <?php
 
-use Clue\React\Zlib\ZlibFilterStream;
+use Clue\React\Zlib\Compressor;
 
-class ZlibFilterZlibCompressorTest extends TestCase
+class ZlibCompressorTest extends TestCase
 {
     private $compressor;
 
     public function setUp()
     {
-        $this->compressor = ZlibFilterStream::createZlibCompressor();
+        $this->compressor = new Compressor(ZLIB_ENCODING_DEFLATE);
     }
 
     public function testCompressEmpty()

tests/ZlibFilterZlibDecompressorTest.php → tests/ZlibDecompressorTest.php

@@ -1,14 +1,14 @@
 <?php
 
-use Clue\React\Zlib\ZlibFilterStream;
+use Clue\React\Zlib\Decompressor;
 
-class ZlibFilterZlibDecompressorTest extends TestCase
+class ZlibDecompressorTest extends TestCase
 {
     private $decompressor;
 
     public function setUp()
     {
-        $this->decompressor = ZlibFilterStream::createZlibDecompressor();
+        $this->decompressor = new Decompressor(ZLIB_ENCODING_DEFLATE);
     }
 
     public function testDecompressEmpty()