[6.x] Allow Storage::put to accept a Psr StreamInterface (#30179)

* Allow Storage::put to accept a Psr StreamInterface

Addresses: laravel/ideas#1252

* Moved psr/http-message to a suggested dependency

* Fixed error in filesystem composer.json

Author: Gman98ish

composer.json

@@ -127,6 +127,7 @@
         "league/flysystem-aws-s3-v3": "Required to use the Flysystem S3 driver (^1.0).",
         "league/flysystem-cached-adapter": "Required to use the Flysystem cache (^1.0).",
         "league/flysystem-sftp": "Required to use the Flysystem SFTP driver (^1.0).",
+        "psr/http-message": "Required to allow Storage::put to accept a StreamInterface (^1.0)",
         "moontoast/math": "Required to use ordered UUIDs (^1.1).",
         "pda/pheanstalk": "Required to use the beanstalk queue driver (^4.0).",
         "pusher/pusher-php-server": "Required to use the Pusher broadcast driver (^4.0).",

src/Illuminate/Filesystem/FilesystemAdapter.php

@@ -20,6 +20,7 @@
 use League\Flysystem\FileNotFoundException;
 use League\Flysystem\FilesystemInterface;
 use PHPUnit\Framework\Assert as PHPUnit;
+use Psr\Http\Message\StreamInterface;
 use RuntimeException;
 use Symfony\Component\HttpFoundation\StreamedResponse;
 
@@ -203,6 +204,10 @@ public function put($path, $contents, $options = [])
             return $this->putFile($path, $contents, $options);
         }
 
+        if ($contents instanceof StreamInterface) {
+            return $this->driver->putStream($path, $contents->detach(), $options);
+        }
+
         return is_resource($contents)
                 ? $this->driver->putStream($path, $contents, $options)
                 : $this->driver->put($path, $contents, $options);

src/Illuminate/Filesystem/composer.json

@@ -33,7 +33,8 @@
         "league/flysystem": "Required to use the Flysystem local and FTP drivers (^1.0).",
         "league/flysystem-aws-s3-v3": "Required to use the Flysystem S3 driver (^1.0).",
         "league/flysystem-cached-adapter": "Required to use the Flysystem cache (^1.0).",
-        "league/flysystem-sftp": "Required to use the Flysystem SFTP driver (^1.0)."
+        "league/flysystem-sftp": "Required to use the Flysystem SFTP driver (^1.0).",
+        "psr/http-message": "Required to allow Storage::put to accept a StreamInterface (^1.0)"
     },
     "config": {
         "sort-packages": true

tests/Filesystem/FilesystemAdapterTest.php

@@ -2,12 +2,14 @@
 
 namespace Illuminate\Tests\Filesystem;
 
+use GuzzleHttp\Psr7\Stream;
 use Illuminate\Contracts\Filesystem\FileExistsException;
 use Illuminate\Contracts\Filesystem\FileNotFoundException;
 use Illuminate\Filesystem\FilesystemAdapter;
 use InvalidArgumentException;
 use League\Flysystem\Adapter\Local;
 use League\Flysystem\Filesystem;
+use Mockery as m;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\StreamedResponse;
 
@@ -26,6 +28,7 @@ protected function tearDown(): void
     {
         $filesystem = new Filesystem(new Local(dirname($this->tempDir)));
         $filesystem->deleteDir(basename($this->tempDir));
+        m::close();
     }
 
     public function testResponse()
@@ -218,4 +221,17 @@ public function testStreamInvalidResourceThrows()
         $filesystemAdapter = new FilesystemAdapter($this->filesystem);
         $filesystemAdapter->writeStream('file.txt', 'foo bar');
     }
+
+    public function testPutWithStreamInterface()
+    {
+        file_put_contents($this->tempDir.'/foo.txt', 'some-data');
+        $spy = m::spy($this->filesystem);
+
+        $filesystemAdapter = new FilesystemAdapter($spy);
+        $stream = new Stream(fopen($this->tempDir.'/foo.txt', 'r'));
+        $filesystemAdapter->put('bar.txt', $stream);
+
+        $spy->shouldHaveReceived('putStream');
+        $this->assertEquals('some-data', $filesystemAdapter->get('bar.txt'));
+    }
 }