Merge branch 'hotfix/247'

Close #247

Author: weierophinney

.travis.yml

@@ -8,6 +8,8 @@ cache:
     - $HOME/.local
     - zf-mkdoc-theme
 
+dist: trusty
+
 env:
   global:
     - COMPOSER_ARGS="--no-interaction"

CHANGELOG.md

@@ -18,7 +18,11 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- Nothing.
+- [#247](https://github.com/zendframework/zend-diactoros/pull/247) fixes the
+  `Stream` and `RelativeStream` `__toString()` method implementations to check
+  if the stream `isSeekable()` before attempting to `rewind()` it, ensuring that
+  the method does not raise exceptions (PHP does not allow exceptions in that
+  method). In particular, this fixes an issue when using AWS S3 streams.
 
 ## 1.4.0 - 2017-04-06
 

src/RelativeStream.php

@@ -48,7 +48,9 @@ public function __construct(StreamInterface $decoratedStream, $offset)
      */
     public function __toString()
     {
-        $this->seek(0);
+        if ($this->isSeekable()) {
+            $this->seek(0);
+        }
         return $this->getContents();
     }
 

src/Stream.php

@@ -48,7 +48,10 @@ public function __toString()
         }
 
         try {
-            $this->rewind();
+            if ($this->isSeekable()) {
+                $this->rewind();
+            }
+
             return $this->getContents();
         } catch (RuntimeException $e) {
             return '';

test/RelativeStreamTest.php

@@ -10,6 +10,7 @@
 namespace ZendTest\Diactoros;
 
 use PHPUnit_Framework_TestCase as TestCase;
+use Prophecy\Argument;
 use Zend\Diactoros\RelativeStream;
 use Zend\Diactoros\Stream;
 
@@ -21,6 +22,7 @@ class RelativeStreamTest extends TestCase
     public function testToString()
     {
         $decorated = $this->prophesize('Zend\Diactoros\Stream');
+        $decorated->isSeekable()->willReturn(true);
         $decorated->tell()->willReturn(100);
         $decorated->seek(100, SEEK_SET)->shouldBeCalled();
         $decorated->getContents()->shouldBeCalled()->willReturn('foobarbaz');
@@ -178,4 +180,16 @@ public function testGetContentsRaisesExceptionWhenPointerIsBehindOffset()
         $stream = new RelativeStream($decorated->reveal(), 100);
         $stream->getContents();
     }
+
+    public function testCanReadContentFromNotSeekableResource()
+    {
+        $decorated = $this->prophesize('Zend\Diactoros\Stream');
+        $decorated->isSeekable()->willReturn(false);
+        $decorated->seek(Argument::any())->shouldNotBeCalled();
+        $decorated->tell()->willReturn(3);
+        $decorated->getContents()->willReturn('CONTENTS');
+
+        $stream = new RelativeStream($decorated->reveal(), 3);
+        $this->assertEquals('CONTENTS', $stream->__toString());
+    }
 }

test/StreamTest.php

@@ -590,4 +590,21 @@ public function getResourceFor67()
 
         return false;
     }
+
+    public function testCanReadContentFromNotSeekableResource()
+    {
+        $this->tmpnam = tempnam(sys_get_temp_dir(), 'diac');
+        file_put_contents($this->tmpnam, 'FOO BAR');
+        $resource = fopen($this->tmpnam, 'r');
+        $stream = $this
+            ->getMockBuilder('Zend\Diactoros\Stream')
+            ->setConstructorArgs([$resource])
+            ->setMethods(['isSeekable'])
+            ->getMock();
+
+        $stream->expects($this->any())->method('isSeekable')
+            ->will($this->returnValue(false));
+
+        $this->assertEquals('FOO BAR', $stream->__toString());
+    }
 }