Add Wrapper::wrap() convenience method

also fix some test class names
icewind1991 · Jul 23, 2014 · a19beaf · a19beaf
1 parent acb8b69
commit a19beaf
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -26,21 +26,20 @@ stream_wrapper_register('callback', '\Icewind\Streams\CallbackWrapper');
 // get an existing stream to wrap
 $source = fopen('php://temp', 'r+');
 
-$context = stream_context_create(array(
-	'callback' => array(
-		'source' => $source,
-		'read' => function ($count) {
-				echo "read " . $count . "bytes\n";
-			},
-		'write' => function ($data) {
-				echo "wrote '" . $data . "'\n";
-			},
-		'close' => function () {
-				echo "stream closed\n";
-			}
-	)
-));
-$stream = fopen('callback://', 'r+', false, $context);
+// register the callbacks
+$stream = CallbackWrapper::wrap($source,
+	// read callback
+	function ($count) {
+		echo "read " . $count . "bytes\n";
+	},
+	// write callback
+	function ($data) {
+		echo "wrote '" . $data . "'\n";
+	},
+	// close callback
+	function () {
+		echo "stream closed\n";
+	});
 
 fwrite($stream, 'some dummy data');
 

diff --git a/src/CallbackWrapper.php b/src/CallbackWrapper.php
@@ -38,6 +38,30 @@ class CallBackWrapper extends Wrapper {
 	 */
 	protected $closeCallback;
 
+	/**
+	 * Wraps a stream with the provided callbacks
+	 *
+	 * @param resource $source
+	 * @param callable $read (optional)
+	 * @param callable $write (optional)
+	 * @param callable $close (optional)
+	 * @return resource
+	 */
+	public static function wrap($source, $read = null, $write = null, $close = null) {
+		stream_wrapper_register('callback', '\Icewind\Streams\CallbackWrapper');
+		$context = stream_context_create(array(
+			'callback' => array(
+				'source' => $source,
+				'read' => $read,
+				'write' => $write,
+				'close' => $close
+			)
+		));
+		$wrapped = fopen('callback://', 'r+', false, $context);
+		stream_wrapper_unregister('callback');
+		return $wrapped;
+	}
+
 	public function stream_open() {
 		$context = $this->loadContext('callback');
 

diff --git a/src/NullWrapper.php b/src/NullWrapper.php
@@ -7,7 +7,27 @@
 
 namespace Icewind\Streams;
 
+/**
+ * Stream wrapper that does nothing, used for tests
+ */
 class NullWrapper extends Wrapper {
+	/**
+	 * Wraps a stream with the provided callbacks
+	 *
+	 * @param resource $source
+	 * @return resource
+	 */
+	public static function wrap($source) {
+		stream_wrapper_register('null', '\Icewind\Streams\NullWrapper');
+		$context = stream_context_create(array(
+			'null' => array(
+				'source' => $source)
+		));
+		$wrapped = fopen('null://', 'r+', false, $context);
+		stream_wrapper_unregister('null');
+		return $wrapped;
+	}
+
 	public function stream_open() {
 		$this->loadContext('null');
 		return true;

diff --git a/tests/CallbackWrapper.php b/tests/CallbackWrapper.php
@@ -7,15 +7,7 @@
 
 namespace Icewind\Streams\Tests;
 
-class CallableWrapper extends Wrapper {
-
-	public function setUp() {
-		stream_wrapper_register('callback', '\Icewind\Streams\CallbackWrapper');
-	}
-
-	public function tearDown() {
-		stream_wrapper_unregister('callback');
-	}
+class CallBackWrapper extends Wrapper {
 
 	/**
 	 * @param resource $source
@@ -25,15 +17,7 @@ public function tearDown() {
 	 * @return resource
 	 */
 	protected function wrapSource($source, $read = null, $write = null, $close = null) {
-		$context = stream_context_create(array(
-			'callback' => array(
-				'source' => $source,
-				'read' => $read,
-				'write' => $write,
-				'close' => $close
-			)
-		));
-		return fopen('callback://', 'r+', false, $context);
+		return \Icewind\Streams\CallbackWrapper::wrap($source, $read, $write, $close);
 	}
 
 	public function testReadCallback() {

diff --git a/tests/NullWrapper.php b/tests/NullWrapper.php
@@ -7,46 +7,46 @@
 
 namespace Icewind\Streams\Tests;
 
-class NullWrapperTest extends Wrapper {
-
-	public function setUp() {
-		stream_wrapper_register('null', '\Icewind\Streams\NullWrapper');
-	}
-
-	public function tearDown() {
-		stream_wrapper_unregister('null');
-	}
+class NullWrapper extends Wrapper {
 
 	/**
 	 * @param resource $source
 	 * @return resource
 	 */
 	protected function wrapSource($source) {
-		$context = stream_context_create(array(
-			'null' => array(
-				'source' => $source
-			)
-		));
-		return fopen('null://', 'r+', false, $context);
+		return \Icewind\Streams\NullWrapper::wrap($source);
 	}
 
 	/**
 	 * @expectedException \BadMethodCallException
 	 */
 	public function testNoContext() {
+		stream_wrapper_register('null', '\Icewind\Streams\NullWrapper');
 		$context = stream_context_create(array());
-		fopen('null://', 'r+', false, $context);
+		try {
+			fopen('null://', 'r+', false, $context);
+			stream_wrapper_unregister('null');
+		} catch (\Exception $e) {
+			stream_wrapper_unregister('null');
+			throw $e;
+		}
 	}
 
 	/**
 	 * @expectedException \BadMethodCallException
 	 */
 	public function testNoSource() {
+		stream_wrapper_register('null', '\Icewind\Streams\NullWrapper');
 		$context = stream_context_create(array(
 			'null' => array(
 				'source' => 'bar'
 			)
 		));
-		fopen('null://', 'r+', false, $context);
+		try {
+			fopen('null://', 'r+', false, $context);
+		} catch (\Exception $e) {
+			stream_wrapper_unregister('null');
+			throw $e;
+		}
 	}
 }