Add Stream decorator

Author: sagikazarmark

spec/Decorator/StreamDecoratorSpec.php

@@ -0,0 +1,154 @@
+<?php
+
+namespace spec\Http\Message\Decorator;
+
+use Http\Message\Decorator\StreamDecorator;
+use Psr\Http\Message\StreamInterface;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+
+class StreamDecoratorSpec extends ObjectBehavior
+{
+    function let(StreamInterface $stream)
+    {
+        $this->beAnInstanceOf('spec\Http\Message\Decorator\StreamDecoratorStub', [$stream]);
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('spec\Http\Message\Decorator\StreamDecoratorStub');
+    }
+
+    function it_is_a_stream_decorator()
+    {
+        $this->shouldUseTrait('Http\Message\Decorator\StreamDecorator');
+    }
+
+    function it_casts_the_stream_to_string(StreamInterface $stream)
+    {
+        $stream->__toString()->willReturn('body');
+
+        $this->__toString()->shouldReturn('body');
+    }
+
+    function it_closes_the_stream(StreamInterface $stream)
+    {
+        $stream->close()->shouldBeCalled();
+
+        $this->close();
+    }
+
+    function it_detaches_the_stream(StreamInterface $stream)
+    {
+        $stream->detach()->willReturn('detached');
+
+        $this->detach()->shouldReturn('detached');
+    }
+
+    function it_returns_the_size_of_the_stream(StreamInterface $stream)
+    {
+        $stream->getSize()->willReturn(1234);
+
+        $this->getSize()->shouldReturn(1234);
+    }
+
+    function it_returns_the_current_position_of_the_stream(StreamInterface $stream)
+    {
+        $stream->tell()->willReturn(0);
+
+        $this->tell()->shouldReturn(0);
+    }
+
+    function it_checks_whether_the_stream_is_eof(StreamInterface $stream)
+    {
+        $stream->eof()->willReturn(false);
+
+        $this->eof()->shouldReturn(false);
+    }
+
+    function it_checks_whether_the_stream_is_seekable(StreamInterface $stream)
+    {
+        $stream->isSeekable()->willReturn(true);
+
+        $this->isSeekable()->shouldReturn(true);
+    }
+
+    function it_seeks_the_current_position_of_the_stream(StreamInterface $stream)
+    {
+        $stream->seek(0, SEEK_SET)->shouldBeCalled();
+
+        $this->seek(0);
+    }
+
+    function it_rewinds_to_the_beginning_of_the_stream(StreamInterface $stream)
+    {
+        $stream->rewind()->shouldBeCalled();
+
+        $this->rewind();
+    }
+
+    function it_checks_whether_the_stream_is_writable(StreamInterface $stream)
+    {
+        $stream->isWritable()->willReturn(true);
+
+        $this->isWritable()->shouldReturn(true);
+    }
+
+    function it_writes_to_the_stream(StreamInterface $stream)
+    {
+        $stream->write('body')->shouldBeCalled();
+
+        $this->write('body');
+    }
+
+    function it_checks_whether_the_stream_is_readable(StreamInterface $stream)
+    {
+        $stream->isReadable()->willReturn(true);
+
+        $this->isReadable()->shouldReturn(true);
+    }
+
+    function it_reads_from_the_stream(StreamInterface $stream)
+    {
+        $stream->read(4)->willReturn('body');
+
+        $this->read(4)->shouldReturn('body');
+    }
+
+    function it_returns_the_contents_of_the_stream(StreamInterface $stream)
+    {
+        $stream->getContents()->willReturn('body');
+
+        $this->getContents()->shouldReturn('body');
+    }
+
+    function it_returns_metadata_of_the_stream(StreamInterface $stream)
+    {
+        $stream->getMetadata(null)->willReturn(['key' => 'value']);
+        $stream->getMetadata('key')->willReturn('value');
+        $stream->getMetadata('key2')->willReturn(null);
+
+        $this->getMetadata()->shouldReturn(['key' => 'value']);
+        $this->getMetadata('key')->shouldReturn('value');
+        $this->getMetadata('key2')->shouldReturn(null);
+    }
+
+    function getMatchers()
+    {
+        return [
+            'useTrait' => function ($subject, $trait) {
+                return class_uses($subject, $trait);
+            }
+        ];
+    }
+}
+
+class StreamDecoratorStub implements StreamInterface
+{
+    use StreamDecorator;
+
+    public function __construct(StreamInterface $stream)
+    {
+        $this->stream = $stream;
+    }
+}

src/Decorator/StreamDecorator.php

@@ -0,0 +1,138 @@
+<?php
+
+namespace Http\Message\Decorator;
+
+use Psr\Http\Message\StreamInterface;
+
+/**
+ * Decorates a stream.
+ *
+ * @author Márk Sági-Kazár <mark.sagikazar@gmail.com>
+ */
+trait StreamDecorator
+{
+    /**
+     * @var StreamInterface
+     */
+    protected $stream;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __toString()
+    {
+        return $this->stream->__toString();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function close()
+    {
+        $this->stream->close();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function detach()
+    {
+        return $this->stream->detach();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSize()
+    {
+        return $this->stream->getSize();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function tell()
+    {
+        return $this->stream->tell();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function eof()
+    {
+        return $this->stream->eof();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isSeekable()
+    {
+        return $this->stream->isSeekable();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function seek($offset, $whence = SEEK_SET)
+    {
+        $this->stream->seek($offset, $whence);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rewind()
+    {
+        $this->stream->rewind();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isWritable()
+    {
+        return $this->stream->isWritable();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function write($string)
+    {
+        return $this->stream->write($string);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isReadable()
+    {
+        return $this->stream->isReadable();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function read($length)
+    {
+        return $this->stream->read($length);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getContents()
+    {
+        return $this->stream->getContents();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getMetadata($key = null)
+    {
+        return $this->stream->getMetadata($key);
+    }
+}