Merge pull request #6 from mecha/task/3_default-ttl

Per-instance default TTL

Author: XedinUnknown

src/CachePool.php

@@ -40,13 +40,18 @@ class CachePool implements CacheInterface
      * @var mixed
      */
     protected $defaultValue;
+    /**
+     * @var int|DateInterval
+     */
+    protected $defaultTtl;
 
     /**
      * @param wpdb   $wpdb         The WP database object.
      * @param string $poolName     The name of this cache pool. Must be unique to this instance.
      * @param mixed $defaultValue  A random value. Used for false-negative detection. The more chaotic - the better.
+     * @param int|DateInterval $defaultTtl Default TTL to use when caching new entries.
      */
-    public function __construct(wpdb $wpdb, string $poolName, $defaultValue)
+    public function __construct(wpdb $wpdb, string $poolName, $defaultValue, $defaultTtl = 0)
     {
         if ($poolName === static::OPTION_NAME_PREFIX_TIMEOUT) {
             throw new RangeException(sprintf('Pool name cannot be "%1$s"', static::OPTION_NAME_PREFIX_TIMEOUT));
@@ -55,6 +60,7 @@ public function __construct(wpdb $wpdb, string $poolName, $defaultValue)
         $this->wpdb = $wpdb;
         $this->poolName = $poolName;
         $this->defaultValue = $defaultValue;
+        $this->defaultTtl = $defaultTtl;
     }
 
     /**
@@ -89,6 +95,8 @@ public function set($key, $value, $ttl = null)
         $origKey = $key;
         $key = $this->prepareKey($key);
 
+        $ttl = is_null($ttl) ? $this->defaultTtl : $ttl;
+
         try {
             $ttl = $ttl instanceof DateInterval
                 ? $this->getIntervalDuration($ttl)
@@ -97,8 +105,6 @@ public function set($key, $value, $ttl = null)
             throw new CacheException(sprintf('Could not normalize cache TTL'));
         }
 
-        $ttl = is_null($ttl) ? 0 : $ttl;
-
         if (!is_int($ttl)) {
             throw new InvalidArgumentException(sprintf('The specified cache TTL is invalid'));
         }

src/CachePoolFactory.php

@@ -3,6 +3,7 @@
 
 namespace WpOop\TransientCache;
 
+use DateInterval;
 use Psr\SimpleCache\CacheInterface;
 use wpdb;
 
@@ -15,10 +16,15 @@ class CachePoolFactory implements CachePoolFactoryInterface
      * @var wpdb
      */
     protected $wpdb;
+    /**
+     * @var int|DateInterval
+     */
+    protected $defaultTtl;
 
-    public function __construct(wpdb $wpdb)
+    public function __construct(wpdb $wpdb, $defaultTtl = 0)
     {
         $this->wpdb = $wpdb;
+        $this->defaultTtl = $defaultTtl;
     }
 
     /**
@@ -27,7 +33,7 @@ public function __construct(wpdb $wpdb)
     public function createCachePool(string $poolName): CacheInterface
     {
         $default = uniqid('default');
-        $pool = new CachePool($this->wpdb, $poolName, $default);
+        $pool = new CachePool($this->wpdb, $poolName, $default, $this->defaultTtl);
 
         return $pool;
     }

tests/functional/CachePoolTest.php

@@ -27,11 +27,11 @@ protected function tearDown()
     /**
      * @return TestSubject&MockObject
      */
-    public function createInstance(wpdb $wpdb, string $poolName, $defaultValue): TestSubject
+    public function createInstance(wpdb $wpdb, string $poolName, $defaultValue, $defaultTtl = null): TestSubject
     {
         $mock = $this->getMockBuilder(TestSubject::class)
             ->setMethods(null)
-            ->setConstructorArgs([$wpdb, $poolName, $defaultValue])
+            ->setConstructorArgs([$wpdb, $poolName, $defaultValue, $defaultTtl])
             ->getMock();
 
         return $mock;
@@ -251,6 +251,35 @@ public function testSet()
         }
     }
 
+    /**
+     * @doesNotPerformAssertions
+     * @throws \Brain\Monkey\Expectation\Exception\ExpectationArgsRequired
+     * @throws \Psr\SimpleCache\InvalidArgumentException
+     */
+    public function testSetDefaultTtl()
+    {
+        {
+            $poolName = uniqid('pool');
+            $wpdb = $this->createWpdb();
+            $key = uniqid('key');
+            $value = uniqid('value');
+            $defaultTtl = new DateInterval('P2D');
+            $separator = TestSubject::NAMESPACE_SEPARATOR;
+            $transientName = "{$poolName}{$separator}{$key}";
+            $subject = $this->createInstance($wpdb, $poolName, uniqid('default'), $defaultTtl);
+        }
+
+        {
+            Functions\expect('set_transient')
+                ->with($transientName, $value, 2 * 60 * 60 * 24)
+                ->andReturn(true);
+        }
+
+        {
+            $subject->set($key, $value, null);
+        }
+    }
+
     /**
      * Tests that a correct exception is thrown when key too long.
      *