Merge pull request #1 from kbond/features

Add Features

Author: kbond

src/Stream.php

@@ -5,7 +5,7 @@
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  */
-final class Stream
+final class Stream implements \Stringable
 {
     /** @var resource */
     private $resource;
@@ -22,6 +22,11 @@ private function __construct($resource)
         $this->resource = $resource;
     }
 
+    public function __toString(): string
+    {
+        return $this->contents();
+    }
+
     /**
      * @param string|resource|self $what
      */
@@ -104,7 +109,7 @@ public function type(): string
      */
     public function contents(?int $length = null, int $offset = -1): string
     {
-        if ($this->metadata('seekable')) {
+        if ($this->isSeekable()) {
             $this->rewind();
         }
 
@@ -115,12 +120,26 @@ public function contents(?int $length = null, int $offset = -1): string
         return $contents;
     }
 
+    /**
+     * @see \file_put_contents()
+     *
+     * @param resource|null $context
+     */
+    public function putContents(string $filename, int $flags = 0, $context = null): self
+    {
+        if (false === @\file_put_contents($filename, $this->get(), $flags, $context)) {
+            throw new \RuntimeException(\sprintf('Unable to dump contents of stream to "%s".', $filename));
+        }
+
+        return $this;
+    }
+
     /**
      * @see \rewind()
      */
     public function rewind(): self
     {
-        if (!$this->metadata('seekable')) {
+        if (!$this->isSeekable()) {
             throw new \RuntimeException('Stream does not support seeking.');
         }
 
@@ -131,6 +150,21 @@ public function rewind(): self
         return $this;
     }
 
+    public function isOpen(): bool
+    {
+        return \is_resource($this->resource);
+    }
+
+    public function isClosed(): bool
+    {
+        return !$this->isOpen();
+    }
+
+    public function isSeekable(): bool
+    {
+        return $this->metadata('seekable');
+    }
+
     /**
      * @see \fwrite()
      * @see \stream_copy_to_stream()

tests/StreamTest.php

@@ -28,6 +28,14 @@ public function can_create_from_string(): void
         $this->assertSame('different data', \stream_get_contents(Stream::wrap('different data')->get()));
     }
 
+    /**
+     * @test
+     */
+    public function stringable(): void
+    {
+        $this->assertSame('some data', (string) Stream::wrap('some data'));
+    }
+
     /**
      * @test
      */
@@ -131,6 +139,7 @@ public function can_get_metadata(): void
 
         $this->assertSame('php://memory', $stream->metadata()['uri']);
         $this->assertSame('php://memory', $stream->metadata('uri'));
+        $this->assertTrue($stream->isSeekable());
     }
 
     /**
@@ -166,4 +175,37 @@ public function can_get_id(): void
 
         $this->assertIsInt($stream->id());
     }
+
+    /**
+     * @test
+     */
+    public function is_open_closed(): void
+    {
+        $stream = Stream::wrap($resource = \fopen(__FILE__, 'r'));
+
+        $this->assertTrue($stream->isOpen());
+        $this->assertFalse($stream->isClosed());
+
+        \fclose($resource);
+
+        $this->assertFalse($stream->isOpen());
+        $this->assertTrue($stream->isClosed());
+    }
+
+    /**
+     * @test
+     */
+    public function put_contents(): void
+    {
+        $file = Stream::tempFile()->uri();
+
+        \file_put_contents($file, '');
+
+        $this->assertFileExists($file);
+        $this->assertSame('', \file_get_contents($file));
+
+        Stream::wrap('content')->putContents($file);
+
+        $this->assertSame('content', \file_get_contents($file));
+    }
 }