[5.5] [PSR-16] Implement SimpleCache (#20194)

* [PSR-16] Implement SimpleCache

* StyleCI

* Fix test for getting multiple values from cache

* Add dependency to Contracts; Drop collection usage

Author: deleugpn

composer.json

@@ -26,6 +26,7 @@
         "mtdowling/cron-expression": "~1.0",
         "nesbot/carbon": "~1.20",
         "psr/container": "~1.0",
+        "psr/simple-cache": "^1.0",
         "ramsey/uuid": "~3.0",
         "swiftmailer/swiftmailer": "~6.0",
         "symfony/console": "~3.3",

src/Illuminate/Cache/Repository.php

@@ -115,6 +115,24 @@ public function many(array $keys)
         })->all();
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getMultiple($keys, $default = null)
+    {
+        if (is_null($default)) {
+            return $this->many($keys);
+        }
+
+        foreach ($keys as $key) {
+            if (! isset($default[$key])) {
+                $default[$key] = null;
+            }
+        }
+
+        return $this->many($default);
+    }
+
     /**
      * Handle a result for the "many" method.
      *
@@ -177,6 +195,14 @@ public function put($key, $value, $minutes = null)
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function set($key, $value, $ttl = null)
+    {
+        $this->put($key, $value, $ttl);
+    }
+
     /**
      * Store multiple items in the cache for a given number of minutes.
      *
@@ -195,6 +221,14 @@ public function putMany(array $values, $minutes)
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function setMultiple($values, $ttl = null)
+    {
+        $this->putMany($values, $ttl);
+    }
+
     /**
      * Store an item in the cache if the key does not exist.
      *
@@ -340,6 +374,34 @@ public function forget($key)
         });
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function delete($key)
+    {
+        return $this->forget($key);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function deleteMultiple($keys)
+    {
+        foreach ($keys as $key) {
+            $this->forget($key);
+        }
+
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function clear()
+    {
+        return $this->store->flush();
+    }
+
     /**
      * Begin executing a new tags operation if the store supports it.
      *

src/Illuminate/Contracts/Cache/Repository.php

@@ -3,8 +3,9 @@
 namespace Illuminate\Contracts\Cache;
 
 use Closure;
+use Psr\SimpleCache\CacheInterface;
 
-interface Repository
+interface Repository extends CacheInterface
 {
     /**
      * Determine if an item exists in the cache.

src/Illuminate/Contracts/composer.json

@@ -15,7 +15,8 @@
     ],
     "require": {
         "php": ">=7.0",
-        "psr/container": "~1.0"
+        "psr/container": "~1.0",
+        "psr/simple-cache": "~1.0"
     },
     "autoload": {
         "psr-4": {

tests/Cache/CacheRepositoryTest.php

@@ -113,6 +113,14 @@ public function testPuttingMultipleItemsInCache()
         $repo->put(['foo' => 'bar', 'bar' => 'baz'], 1);
     }
 
+    public function testSettingMultipleItemsInCache()
+    {
+        // Alias of PuttingMultiple
+        $repo = $this->getRepository();
+        $repo->getStore()->shouldReceive('putMany')->once()->with(['foo' => 'bar', 'bar' => 'baz'], 1);
+        $repo->setMultiple(['foo' => 'bar', 'bar' => 'baz'], 1);
+    }
+
     public function testPutWithDatetimeInPastOrZeroSecondsDoesntSaveItem()
     {
         $repo = $this->getRepository();
@@ -174,6 +182,53 @@ public function testRegisterMacroWithNonStaticCall()
         $this->assertEquals($repo->{__CLASS__}(), 'Taylor');
     }
 
+    public function testForgettingCacheKey()
+    {
+        $repo = $this->getRepository();
+        $repo->getStore()->shouldReceive('forget')->once()->with('a-key')->andReturn(true);
+        $repo->forget('a-key');
+    }
+
+    public function testRemovingCacheKey()
+    {
+        // Alias of Forget
+        $repo = $this->getRepository();
+        $repo->getStore()->shouldReceive('forget')->once()->with('a-key')->andReturn(true);
+        $repo->delete('a-key');
+    }
+
+    public function testSettingCache()
+    {
+        $repo = $this->getRepository();
+        $repo->getStore()->shouldReceive('put')->with($key = 'foo', $value = 'bar', 1);
+        $repo->set($key, $value, 1);
+    }
+
+    public function testClearingWholeCache()
+    {
+        $repo = $this->getRepository();
+        $repo->getStore()->shouldReceive('flush')->andReturn(true);
+        $repo->clear();
+    }
+
+    public function testGettingMultipleValuesFromCache()
+    {
+        $keys = ['key1', 'key2', 'key3'];
+        $default = ['key2' => 5];
+
+        $repo = $this->getRepository();
+        $repo->getStore()->shouldReceive('many')->once()->with(['key2', 'key1', 'key3'])->andReturn(['key1' => 1, 'key2' => null, 'key3' => null]);
+        $this->assertEquals(['key1' => 1, 'key2' => 5, 'key3' => null], $repo->getMultiple($keys, $default));
+    }
+
+    public function testRemovingMultipleKeys()
+    {
+        $repo = $this->getRepository();
+        $repo->getStore()->shouldReceive('forget')->once()->with('a-key')->andReturn(true);
+        $repo->getStore()->shouldReceive('forget')->once()->with('a-second-key')->andReturn(true);
+        $repo->deleteMultiple(['a-key', 'a-second-key']);
+    }
+
     protected function getRepository()
     {
         $dispatcher = new \Illuminate\Events\Dispatcher(m::mock('Illuminate\Container\Container'));