Correctly set up overriding of traits

Author: Corey McCormick

src/Cacheable.php

@@ -5,26 +5,41 @@
 trait Cacheable
 {
     /**
-     * Configures the cache store to be used.
+     * Returns the Cache store to use.
      *
-     * @var
+     * @return null|string
      */
-    protected $cacheStore;
+    public function getCacheStore()
+    {
+        if (property_exists($this, 'cacheStore')) return $this->cacheStore;
+
+        return null;
+    }
 
     /**
-     * Determines the length to cache a result.
+     * Returns if the cache should be busted
+     * on inserts/updates/delete.
      *
-     * @var int
+     * @return bool
      */
-    protected $cacheLength = 30;
+    public function getCacheBusting()
+    {
+        if (property_exists($this, 'cacheBusting')) return $this->cacheBusting;
+
+        return false;
+    }
 
     /**
-     * Determines if the cache should be busted
-     * on inserts/updates/deletes.
+     * Gets the length of the cache.  Defaults to 30 minutes.
      *
-     * @var bool
+     * @return int
      */
-    protected $cacheBusting = false;
+    public function getCacheLength()
+    {
+        if (property_exists($this, 'cacheLength')) return $this->cacheLength;
+
+        return 30;
+    }
 
     /**
      * Overrides the default QueryBuilder to inject the Cache methods.
@@ -47,7 +62,7 @@ protected function newBaseQueryBuilder()
      */
     protected function queryCache()
     {
-        return new QueryCache($this->cacheStore, $this->cacheLength);
+        return new QueryCache($this->cacheStore, $this->getCacheLength());
     }
 
     /**

tests/CacheableTest.php

@@ -16,6 +16,66 @@ public function tearDown()
         Mockery::close();
     }
 
+    /** @test */
+    public function the_correct_cache_store_is_returned_when_a_cache_store_is_set()
+    {
+        $model = new class extends EloquentModel {
+            use Cacheable;
+
+            protected $cacheStore= 'fooStore';
+        };
+
+        $this->assertEquals('fooStore', $model->getCacheStore());
+    }
+
+    /** @test */
+    public function null_is_returned_when_a_cache_store_is_not_set()
+    {
+        $model = new Model;
+
+        $this->assertNull($model->getCacheStore());
+    }
+
+    /** @test */
+    public function cache_busting_returns_true_when_cache_busting_is_set()
+    {
+        $model = new class extends EloquentModel {
+            use Cacheable;
+
+            protected $cacheBusting = true;
+        };
+
+        $this->assertTrue($model->getCacheBusting());
+    }
+
+    /** @test */
+    public function cache_busting_returns_false_when_no_cache_busting_is_set()
+    {
+        $model = new Model;
+
+        $this->assertFalse($model->getCacheBusting());
+    }
+
+    /** @test */
+    public function thirty_minutes_are_returned_when_no_cache_length_is_set()
+    {
+        $model = new Model();
+
+        $this->assertEquals(30, $model->getCacheLength());
+    }
+
+    /** @test */
+    public function the_correct_length_is_returned_when_a_length_is_set()
+    {
+        $model = new class extends EloquentModel {
+            use Cacheable;
+
+            protected $cacheLength = 45;
+        };
+
+        $this->assertEquals(45, $model->getCacheLength());
+    }
+
     /** @test */
     public function insert_and_update_bust_the_cache_when_busting_is_enabled()
     {