Add CountWrapper

src/CountWrapper.php

@@ -0,0 +1,106 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Icewind\Streams;
+
+/**
+ * Wrapper that counts the amount of data read and written
+ *
+ * The following options should be passed in the context when opening the stream
+ * [
+ *     'callback' => [
+ *        'source'  => resource
+ *        'callback'    => function($readCount, $writeCount){}
+ *     ]
+ * ]
+ *
+ * The callback will be called when the stream is closed
+ */
+class CountWrapper extends Wrapper {
+	/**
+	 * @var int
+	 */
+	protected $readCount = 0;
+
+	/**
+	 * @var int
+	 */
+	protected $writeCount = 0;
+
+	/**
+	 * @var callable
+	 */
+	protected $callback;
+
+	/**
+	 * Wraps a stream with the provided callbacks
+	 *
+	 * @param resource $source
+	 * @param callable $callback
+	 * @return resource
+	 *
+	 * @throws \BadMethodCallException
+	 */
+	public static function wrap($source, $callback) {
+		if (!is_callable($callback)) {
+			throw new \InvalidArgumentException('Invalid or missing callback');
+		}
+		$context = stream_context_create(array(
+			'count' => array(
+				'source' => $source,
+				'callback' => $callback
+			)
+		));
+		return Wrapper::wrapSource($source, $context, 'callback', '\Icewind\Streams\CountWrapper');
+	}
+
+	protected function open() {
+		$context = $this->loadContext('count');
+		$this->callback = $context['callback'];
+		return true;
+	}
+
+	public function dir_opendir($path, $options) {
+		return $this->open();
+	}
+
+	public function stream_open($path, $mode, $options, &$opened_path) {
+		return $this->open();
+	}
+
+	public function stream_read($count) {
+		$result = parent::stream_read($count);
+		$this->readCount += strlen($result);
+		return $result;
+	}
+
+	public function stream_write($data) {
+		$result = parent::stream_write($data);
+		$this->writeCount += strlen($data);
+		return $result;
+	}
+
+	public function stream_close() {
+		$result = parent::stream_close();
+		call_user_func($this->callback, $this->readCount, $this->writeCount);
+		return $result;
+	}
+}

tests/CallbackWrapper.php → tests/CallbackWrapperTest.php

@@ -7,7 +7,7 @@
 
 namespace Icewind\Streams\Tests;
 
-class CallbackWrapper extends Wrapper {
+class CallbackWrapperTest extends WrapperTest {
 
 	/**
 	 * @param resource $source

tests/CountWrapperTest.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Icewind\Streams\Tests;
+
+
+use Icewind\Streams\CountWrapper;
+
+class CountWrapperTest extends WrapperTest {
+	protected function wrapSource($source, $callback = null) {
+		if (is_null($callback)) {
+			$callback = function () {
+			};
+		}
+		return CountWrapper::wrap($source, $callback);
+	}
+
+	public function testReadCount() {
+		$count = 0;
+
+		$source = fopen('php://temp', 'r+');
+		fwrite($source, 'foobar');
+		rewind($source);
+
+		$wrapped = CountWrapper::wrap($source, function ($readCount) use (&$count) {
+			$count = $readCount;
+		});
+
+		stream_get_contents($wrapped);
+		fclose($wrapped);
+		$this->assertEquals(6, $count);
+	}
+
+	public function testWriteCount() {
+		$count = 0;
+
+		$source = fopen('php://temp', 'r+');
+
+		$wrapped = CountWrapper::wrap($source, function ($readCount, $writeCount) use (&$count) {
+			$count = $writeCount;
+		});
+
+		fwrite($wrapped, 'foobar');
+		fclose($wrapped);
+		$this->assertEquals(6, $count);
+	}
+}

tests/NullWrapper.php → tests/NullWrapperTest.php

@@ -7,7 +7,7 @@
 
 namespace Icewind\Streams\Tests;
 
-class NullWrapper extends Wrapper {
+class NullWrapperTest extends WrapperTest {
 
 	/**
 	 * @param resource $source

tests/RetryWrapper.php

@@ -61,7 +61,7 @@ public function stream_write($data) {
 	}
 }
 
-class RetryWrapper extends Wrapper {
+class RetryWrapperTest extends WrapperTest {
 
 	/**
 	 * @param resource $source

tests/Wrapper.php → tests/WrapperTest.php

@@ -7,7 +7,7 @@
 
 namespace Icewind\Streams\Tests;
 
-abstract class Wrapper extends \PHPUnit_Framework_TestCase {
+abstract class WrapperTest extends \PHPUnit_Framework_TestCase {
 	/**
 	 * @param resource $source
 	 * @return resource