Merge pull request #48 from sunrise-php/release/v3.8.0

v3.8

Author: fenric

src/FileStreamInterface.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+/**
+ * It's free open-source software released under the MIT License.
+ *
+ * @author Anatoly Nekhay <afenric@gmail.com>
+ * @copyright Copyright (c) 2018, Anatoly Nekhay
+ * @license https://github.com/sunrise-php/http-message/blob/master/LICENSE
+ * @link https://github.com/sunrise-php/http-message
+ */
+
+namespace Sunrise\Http\Message;
+
+use Psr\Http\Message\StreamInterface;
+
+interface FileStreamInterface extends StreamInterface
+{
+    public function getFilename(): string;
+}

src/HeaderInterface.php

@@ -11,12 +11,7 @@
 
 namespace Sunrise\Http\Message;
 
-use IteratorAggregate;
-
-/**
- * @extends IteratorAggregate<int, string>
- */
-interface HeaderInterface extends IteratorAggregate
+interface HeaderInterface
 {
     public const RFC822_DATE_FORMAT = 'D, d M y H:i:s O';
 

src/Stream/FileStream.php

@@ -12,14 +12,15 @@
 namespace Sunrise\Http\Message\Stream;
 
 use Sunrise\Http\Message\Exception\InvalidArgumentException;
+use Sunrise\Http\Message\FileStreamInterface;
 use Sunrise\Http\Message\Stream;
 use Throwable;
 
 use function fopen;
 use function is_resource;
 use function sprintf;
 
-final class FileStream extends Stream
+final class FileStream extends Stream implements FileStreamInterface
 {
     /**
      * @throws InvalidArgumentException
@@ -29,6 +30,14 @@ public function __construct(string $filename, string $mode)
         parent::__construct(self::openFile($filename, $mode));
     }
 
+    public function getFilename(): string
+    {
+        /** @var string $filename */
+        $filename = $this->getMetadata('uri');
+
+        return $filename;
+    }
+
     /**
      * @return resource
      *
@@ -46,7 +55,7 @@ private static function openFile(string $filename, string $mode)
             throw new InvalidArgumentException(sprintf(
                 'Unable to open the file "%s" in the mode "%s"',
                 $filename,
-                $mode
+                $mode,
             ));
         }
 

src/Stream/TempFileStream.php

@@ -12,6 +12,7 @@
 namespace Sunrise\Http\Message\Stream;
 
 use Sunrise\Http\Message\Exception\RuntimeException;
+use Sunrise\Http\Message\FileStreamInterface;
 use Sunrise\Http\Message\Stream;
 
 use function fopen;
@@ -20,7 +21,7 @@
 use function sys_get_temp_dir;
 use function tempnam;
 
-final class TempFileStream extends Stream
+final class TempFileStream extends Stream implements FileStreamInterface
 {
     /**
      * @throws RuntimeException
@@ -30,6 +31,14 @@ public function __construct(string $prefix = '')
         parent::__construct(self::createFile($prefix));
     }
 
+    public function getFilename(): string
+    {
+        /** @var string $filename */
+        $filename = $this->getMetadata('uri');
+
+        return $filename;
+    }
+
     /**
      * @return resource
      *

src/Stream/TmpfileStream.php

@@ -12,6 +12,7 @@
 namespace Sunrise\Http\Message\Stream;
 
 use Sunrise\Http\Message\Exception\RuntimeException;
+use Sunrise\Http\Message\FileStreamInterface;
 use Sunrise\Http\Message\Stream;
 
 use function is_resource;
@@ -24,7 +25,7 @@
  * read/write (w+b) mode. The file will be automatically deleted
  * when it is closed or the program terminates.
  */
-final class TmpfileStream extends Stream
+final class TmpfileStream extends Stream implements FileStreamInterface
 {
     /**
      * @throws RuntimeException
@@ -34,6 +35,14 @@ public function __construct()
         parent::__construct(self::createFile());
     }
 
+    public function getFilename(): string
+    {
+        /** @var string $filename */
+        $filename = $this->getMetadata('uri');
+
+        return $filename;
+    }
+
     /**
      * @return resource
      *

tests/Stream/FileStreamTest.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sunrise\Http\Message\Tests\Stream;
+
+use PHPUnit\Framework\TestCase;
+use Sunrise\Http\Message\Stream\FileStream;
+
+final class FileStreamTest extends TestCase
+{
+    public function testFilename(): void
+    {
+        $stream = new FileStream(__FILE__, 'r');
+        self::assertSame(__FILE__, $stream->getFilename());
+    }
+}

tests/Stream/TempFileStreamTest.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sunrise\Http\Message\Tests\Stream;
+
+use PHPUnit\Framework\TestCase;
+use Sunrise\Http\Message\Stream\TempFileStream;
+
+final class TempFileStreamTest extends TestCase
+{
+    public function testFilename() : void
+    {
+        $stream = new TempFileStream();
+        self::assertFileExists($stream->getFilename());
+    }
+}

tests/Stream/TmpfileStreamTest.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sunrise\Http\Message\Tests\Stream;
+
+use PHPUnit\Framework\TestCase;
+use Sunrise\Http\Message\Stream\TmpfileStream;
+
+final class TmpfileStreamTest extends TestCase
+{
+    public function testFilename(): void
+    {
+        $stream = new TmpfileStream();
+        self::assertFileExists($stream->getFilename());
+    }
+}