Drop bust and dontBust in favor for flush

Author: Corey McCormick

README.md

@@ -103,17 +103,11 @@ Cache busting will automatically invalid the cache when an `insert/update/delete
 
 ### Methods
 
-#### bust()
+#### flush()
 
-The `bust` method will enable cache busting for the model
+The `flush` method will flush the cache for a model.
 
-    User::bust();  //Cache busting is enabled.
-    
-#### dontBust()
-
-The `dontBust` method will disable cache busting for the model.
-
-    User::dontBust();  //Cache busting is disabled.
+    User::flush();  //Cache is flushed for the `User` model.
 
 #### isBusting()
 

src/Cacheable.php

@@ -99,36 +99,24 @@ public function delete()
     }
 
     /**
-     * Enables cache busting.
+     * Returns the status of cache busting.
      *
-     * @return Cacheable
+     * @return bool
      */
-    public function bust()
+    public function isBusting()
     {
-        $this->cacheBusting = true;
-
-        return $this;
+        return $this->getCacheBusting();
     }
 
     /**
-     * Disables cache busting.
+     * Flushes the cache.
      *
-     * @return Cacheable
+     * @return $this
      */
-    public function dontBust()
+    public function flush()
     {
-        $this->cacheBusting = false;
+        $this->queryCache()->flush($this->getTable());
 
         return $this;
     }
-
-    /**
-     * Returns the status of cache busting.
-     *
-     * @return bool
-     */
-    public function isBusting()
-    {
-        return $this->getCacheBusting();
-    }
 }

tests/CacheableTest.php

@@ -9,6 +9,13 @@ class Model extends EloquentModel
     use Cacheable;
 }
 
+class BustingModel extends EloquentModel
+{
+    use Cacheable;
+
+    protected $cacheBusting = true;
+}
+
 class CacheableTest extends PHPUnit_Framework_TestCase
 {
     public function tearDown()
@@ -79,7 +86,7 @@ public function the_correct_length_is_returned_when_a_length_is_set()
     /** @test */
     public function insert_and_update_bust_the_cache_when_busting_is_enabled()
     {
-        $model = Mockery::mock('Model[queryCache]')
+        $model = Mockery::mock('BustingModel[queryCache]')
             ->shouldAllowMockingProtectedMethods();
 
         $queryCache = Mockery::mock(QueryCache::class);
@@ -90,8 +97,6 @@ public function insert_and_update_bust_the_cache_when_busting_is_enabled()
             ->once()
             ->andReturn($queryCache);
 
-        $model->bust();
-
         $model->finishSave([]);
     }
 
@@ -104,15 +109,13 @@ public function insert_and_update_do_not_bust_the_cache_when_busting_is_disabled
         $model->shouldReceive('queryCache')
             ->times(0);
 
-        $model->dontBust();
-
         $model->finishSave([]);
     }
 
     /** @test */
     public function delete_should_bust_the_cache_when_busting_is_enabled()
     {
-        $model = Mockery::mock('Model[queryCache]')
+        $model = Mockery::mock('BustingModel[queryCache]')
             ->shouldAllowMockingProtectedMethods();
 
         $queryCache = Mockery::mock(QueryCache::class);
@@ -123,8 +126,6 @@ public function delete_should_bust_the_cache_when_busting_is_enabled()
             ->once()
             ->andReturn($queryCache);
 
-        $model->bust();
-
         $model->delete();
     }
 
@@ -137,28 +138,23 @@ public function delete_should_not_bust_the_cache_when_busting_is_disabled()
         $model->shouldReceive('queryCache')
             ->times(0);
 
-        $model->dontBust();
-
         $model->delete();
     }
 
     /** @test */
-    public function bust_enables_cache_busting()
+    public function flush_empties_the_cache()
     {
-        $model = new Model;
-
-        $model->bust();
-
-        $this->assertTrue($model->isBusting());
-    }
+        $model = Mockery::mock('BustingModel[queryCache]')
+            ->shouldAllowMockingProtectedMethods();
 
-    /** @test */
-    public function dont_bust_disables_cache_busting()
-    {
-        $model = new Model;
+        $queryCache = Mockery::mock(QueryCache::class);
+        $queryCache->shouldReceive('flush')
+            ->once();
 
-        $model->dontBust();
+        $model->shouldReceive('queryCache')
+            ->once()
+            ->andReturn($queryCache);
 
-        $this->assertFalse($model->isBusting());
+        $model->flush();
     }
 }